Acknowledges a subscription purchase.
cancel(packageName, subscriptionId, token, x__xgafv=None)
Cancels a user's subscription purchase. The subscription remains valid until its expiration time. Newer version is available at purchases.subscriptionsv2.cancel for better client library support.
+Deprecated: Use purchases.subscriptionsv2.cancel instead. Cancels a user's subscription purchase. The subscription remains valid until its expiration time. Newer version is available at purchases.subscriptionsv2.cancel for better client library support.
Close httplib2 connections.
defer(packageName, subscriptionId, token, body=None, x__xgafv=None)
Defers a user's subscription purchase until a specified future expiration time.
+Deprecated: Use purchases.subscriptionsv2.defer instead. Defers a user's subscription purchase until a specified future expiration time.
get(packageName, subscriptionId, token, x__xgafv=None)
Deprecated: Use purchases.subscriptionsv2.get instead. Checks whether a user's subscription purchase is valid and returns its expiry time.
@@ -124,7 +124,7 @@cancel(packageName, subscriptionId, token, x__xgafv=None)
- Cancels a user's subscription purchase. The subscription remains valid until its expiration time. Newer version is available at purchases.subscriptionsv2.cancel for better client library support. +Deprecated: Use purchases.subscriptionsv2.cancel instead. Cancels a user's subscription purchase. The subscription remains valid until its expiration time. Newer version is available at purchases.subscriptionsv2.cancel for better client library support. Args: packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required) @@ -144,7 +144,7 @@Method Details
diff --git a/docs/dyn/cloudbuild_v1.projects.builds.html b/docs/dyn/cloudbuild_v1.projects.builds.html index fd24f87902..6c76399f5c 100644 --- a/docs/dyn/cloudbuild_v1.projects.builds.html +++ b/docs/dyn/cloudbuild_v1.projects.builds.html @@ -349,6 +349,13 @@defer(packageName, subscriptionId, token, body=None, x__xgafv=None)-Defers a user's subscription purchase until a specified future expiration time. +Deprecated: Use purchases.subscriptionsv2.defer instead. Defers a user's subscription purchase until a specified future expiration time. Args: packageName: string, The package name of the application for which this subscription was purchased (for example, 'com.some.thing'). (required) @@ -189,7 +189,7 @@@@ -283,7 +283,7 @@Method Details
Returns: An object of the form: - { # A SubscriptionPurchase resource indicates the status of a user's subscription purchase. + { # Deprecated: Use SubscriptionPurchaseV2 instead. A SubscriptionPurchase resource indicates the status of a user's subscription purchase. "acknowledgementState": 42, # The acknowledgement state of the subscription product. Possible values are: 0. Yet to be acknowledged 1. Acknowledged "autoRenewing": True or False, # Whether the subscription will automatically be renewed when it reaches its current expiry time. "autoResumeTimeMillis": "A String", # Time at which the subscription will be automatically resumed, in milliseconds since the Epoch. Only present if the user has requested to pause the subscription. diff --git a/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html b/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html index 9eda747c72..6f2274eb03 100644 --- a/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html +++ b/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html @@ -197,6 +197,11 @@Method Details
"obfuscatedExternalAccountId": "A String", # An obfuscated version of the id that is uniquely associated with the user's account in your app. Present for the following purchases: * If account linking happened as part of the subscription purchase flow. * It was specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid when the purchase was made. "obfuscatedExternalProfileId": "A String", # An obfuscated version of the id that is uniquely associated with the user's profile in your app. Only present if specified using https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid when the purchase was made. }, + "inGracePeriodStateContext": { # Additional context around subscriptions in IN_GRACE_PERIOD state. # Optional. Additional context around subscriptions in IN_GRACE_PERIOD state. Only present if the subscription currently has subscription_state SUBSCRIPTION_STATE_IN_GRACE_PERIOD. + "renewalDeclined": { # Context related to renewal declined scenario. # Optional. The payment for the renewal was declined. + "pendingOrderId": "A String", # Required. The ID of the pending or failed order causing the state. + }, + }, "kind": "A String", # This kind represents a SubscriptionPurchaseV2 object in the androidpublisher service. "latestOrderId": "A String", # Deprecated: Use line_items.latest_successful_order_id instead. The order id of the latest order associated with the purchase of the subscription. For autoRenewing subscription, this is the order id of signup order if it is not renewed yet, or the last recurring order id (success, pending, or declined order). For prepaid subscription, this is the order id associated with the queried purchase token. "lineItems": [ # Item-level info for a subscription purchase. The items in the same purchase should be either all with AutoRenewingPlan or all with PrepaidPlan. @@ -280,6 +285,11 @@Method Details
}, ], "linkedPurchaseToken": "A String", # The purchase token of the old subscription if this subscription is one of the following: * Re-signup of a canceled but non-lapsed subscription * Upgrade/downgrade from a previous subscription. * Convert from prepaid to auto renewing subscription. * Convert from an auto renewing subscription to prepaid. * Topup a prepaid subscription. + "onHoldStateContext": { # Additional context around subscriptions in ON_HOLD state. # Optional. Additional context around subscriptions in ON_HOLD state. Only present if the subscription currently has subscription_state SUBSCRIPTION_STATE_ON_HOLD. + "renewalDeclined": { # Context related to renewal declined scenario. # Optional. The payment for the renewal was declined. + "pendingOrderId": "A String", # Required. The ID of the pending or failed order causing the state. + }, + }, "outOfAppPurchaseContext": { # Information specific to an out of app purchase. # Additional context for out of app purchases. This information is only present for re-subscription purchases (subscription purchases made after the previous subscription of the same product has expired) made through the Google Play subscriptions center. This field will be removed after you acknowledge the subscription. "expiredExternalAccountIdentifiers": { # User account identifier in the third-party service. # User account identifier from the last expired subscription for this SKU. "externalAccountId": "A String", # User account identifier in the third-party service. Only present if account linking happened as part of the subscription purchase flow. diff --git a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html index 97718e7bf7..0f2194663b 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html @@ -1530,6 +1530,7 @@Method Details
}, "computeInstanceTargetEnvironment": { # ComputeInstanceTargetEnvironment represents Compute Engine target environment to be used during restore. # Compute Engine target environment to be used during restore. "project": "A String", # Required. Target project for the Compute Engine instance. + "useProjectServiceAccount": True or False, # Optional. Whether to use the project service account for the Compute Engine instance. "zone": "A String", # Required. The zone of the Compute Engine instance. }, "diskRestoreProperties": { # DiskRestoreProperties represents the properties of a Disk restore. # Disk properties to be overridden during restore. @@ -1570,6 +1571,7 @@Method Details
}, "diskTargetEnvironment": { # DiskTargetEnvironment represents the target environment for the disk. # Disk target environment to be used during restore. "project": "A String", # Required. Target project for the disk. + "useProjectServiceAccount": True or False, # Optional. Whether to use the project service account for the disk. "zone": "A String", # Required. Target zone for the disk. }, "regionDiskTargetEnvironment": { # RegionDiskTargetEnvironment represents the target environment for the disk. # Region disk target environment to be used during restore. @@ -1578,6 +1580,7 @@Method Details
"replicaZones": [ # Required. Target URLs of the replica zones for the disk. "A String", ], + "useProjectServiceAccount": True or False, # Optional. Whether to use the project service account for the disk. }, "requestId": "A 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 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/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index 3d7ff425bd..3dc8134086 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -266,11 +266,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -530,11 +542,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -749,6 +773,9 @@Method Details
}, "functionStats": [ # Function level stats for GenAi Functions. See https://docs.cloud.google.com/bigquery/docs/generative-ai-overview { # Provides statistics for each Ai function call within a query. + "cacheStats": { # Provides cache statistics for a GenAi function call. # Cache stats for the function. + "numCacheHitRows": "A String", # Number of rows served from cache. + }, "costOptimizationStats": { # Provides cost optimization statistics for a GenAi function call. # Cost optimization stats if applied on the rows processed by the function. "message": "A String", # System generated message to provide insights into cost optimization state. "numCostOptimizedRows": "A String", # Number of rows inferred via cost optimized workflow. @@ -1355,6 +1382,20 @@Method Details
"stageId": "A String", # Output only. The stage id that the insight mapped to. }, ], + "tableChangeInsights": [ # Output only. Performance insights for table-level attributes that changed compared to previous runs. + { # Table-level performance insights compared to previous runs. These insights don't apply to specific query stages, rather they apply to the whole table. + "metadataCacheNotUsedButUsedPreviously": True or False, # Output only. True if the table's column metadata index was not used in the current job, but was used in a previous job with the same query hash. + "metadataCacheStalenessInsight": { # Column Metadata Index staleness detailed infnormation. # Output only. If present, indicates that the table's metadata column index staleness has increased significantly compared to previous jobs with the same query hash. + "avgPreviousStalenessMs": "A String", # Output only. Average column metadata index staleness of previous runs with the same query hash. + "stalenessPercentageIncrease": 3.14, # Output only. The percent increase in staleness between the current job and the average staleness of previous jobs with the same query hash. + }, + "tableReference": { # Output only. The table that was queried. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + }, + ], }, "queryInfo": { # Query optimization information for a QUERY job. # Output only. Query optimization information for a QUERY job. "optimizationDetails": { # Output only. Information about query optimizations. @@ -1441,11 +1482,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -1849,11 +1902,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -2113,11 +2178,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -2332,6 +2409,9 @@Method Details
}, "functionStats": [ # Function level stats for GenAi Functions. See https://docs.cloud.google.com/bigquery/docs/generative-ai-overview { # Provides statistics for each Ai function call within a query. + "cacheStats": { # Provides cache statistics for a GenAi function call. # Cache stats for the function. + "numCacheHitRows": "A String", # Number of rows served from cache. + }, "costOptimizationStats": { # Provides cost optimization statistics for a GenAi function call. # Cost optimization stats if applied on the rows processed by the function. "message": "A String", # System generated message to provide insights into cost optimization state. "numCostOptimizedRows": "A String", # Number of rows inferred via cost optimized workflow. @@ -2938,6 +3018,20 @@Method Details
"stageId": "A String", # Output only. The stage id that the insight mapped to. }, ], + "tableChangeInsights": [ # Output only. Performance insights for table-level attributes that changed compared to previous runs. + { # Table-level performance insights compared to previous runs. These insights don't apply to specific query stages, rather they apply to the whole table. + "metadataCacheNotUsedButUsedPreviously": True or False, # Output only. True if the table's column metadata index was not used in the current job, but was used in a previous job with the same query hash. + "metadataCacheStalenessInsight": { # Column Metadata Index staleness detailed infnormation. # Output only. If present, indicates that the table's metadata column index staleness has increased significantly compared to previous jobs with the same query hash. + "avgPreviousStalenessMs": "A String", # Output only. Average column metadata index staleness of previous runs with the same query hash. + "stalenessPercentageIncrease": 3.14, # Output only. The percent increase in staleness between the current job and the average staleness of previous jobs with the same query hash. + }, + "tableReference": { # Output only. The table that was queried. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + }, + ], }, "queryInfo": { # Query optimization information for a QUERY job. # Output only. Query optimization information for a QUERY job. "optimizationDetails": { # Output only. Information about query optimizations. @@ -3024,11 +3118,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -3315,11 +3421,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -3528,11 +3646,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -3792,11 +3922,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -4011,6 +4153,9 @@Method Details
}, "functionStats": [ # Function level stats for GenAi Functions. See https://docs.cloud.google.com/bigquery/docs/generative-ai-overview { # Provides statistics for each Ai function call within a query. + "cacheStats": { # Provides cache statistics for a GenAi function call. # Cache stats for the function. + "numCacheHitRows": "A String", # Number of rows served from cache. + }, "costOptimizationStats": { # Provides cost optimization statistics for a GenAi function call. # Cost optimization stats if applied on the rows processed by the function. "message": "A String", # System generated message to provide insights into cost optimization state. "numCostOptimizedRows": "A String", # Number of rows inferred via cost optimized workflow. @@ -4617,6 +4762,20 @@Method Details
"stageId": "A String", # Output only. The stage id that the insight mapped to. }, ], + "tableChangeInsights": [ # Output only. Performance insights for table-level attributes that changed compared to previous runs. + { # Table-level performance insights compared to previous runs. These insights don't apply to specific query stages, rather they apply to the whole table. + "metadataCacheNotUsedButUsedPreviously": True or False, # Output only. True if the table's column metadata index was not used in the current job, but was used in a previous job with the same query hash. + "metadataCacheStalenessInsight": { # Column Metadata Index staleness detailed infnormation. # Output only. If present, indicates that the table's metadata column index staleness has increased significantly compared to previous jobs with the same query hash. + "avgPreviousStalenessMs": "A String", # Output only. Average column metadata index staleness of previous runs with the same query hash. + "stalenessPercentageIncrease": 3.14, # Output only. The percent increase in staleness between the current job and the average staleness of previous jobs with the same query hash. + }, + "tableReference": { # Output only. The table that was queried. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + }, + ], }, "queryInfo": { # Query optimization information for a QUERY job. # Output only. Query optimization information for a QUERY job. "optimizationDetails": { # Output only. Information about query optimizations. @@ -4703,11 +4862,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -5082,11 +5253,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -5346,11 +5529,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -5565,6 +5760,9 @@Method Details
}, "functionStats": [ # Function level stats for GenAi Functions. See https://docs.cloud.google.com/bigquery/docs/generative-ai-overview { # Provides statistics for each Ai function call within a query. + "cacheStats": { # Provides cache statistics for a GenAi function call. # Cache stats for the function. + "numCacheHitRows": "A String", # Number of rows served from cache. + }, "costOptimizationStats": { # Provides cost optimization statistics for a GenAi function call. # Cost optimization stats if applied on the rows processed by the function. "message": "A String", # System generated message to provide insights into cost optimization state. "numCostOptimizedRows": "A String", # Number of rows inferred via cost optimized workflow. @@ -6171,6 +6369,20 @@Method Details
"stageId": "A String", # Output only. The stage id that the insight mapped to. }, ], + "tableChangeInsights": [ # Output only. Performance insights for table-level attributes that changed compared to previous runs. + { # Table-level performance insights compared to previous runs. These insights don't apply to specific query stages, rather they apply to the whole table. + "metadataCacheNotUsedButUsedPreviously": True or False, # Output only. True if the table's column metadata index was not used in the current job, but was used in a previous job with the same query hash. + "metadataCacheStalenessInsight": { # Column Metadata Index staleness detailed infnormation. # Output only. If present, indicates that the table's metadata column index staleness has increased significantly compared to previous jobs with the same query hash. + "avgPreviousStalenessMs": "A String", # Output only. Average column metadata index staleness of previous runs with the same query hash. + "stalenessPercentageIncrease": 3.14, # Output only. The percent increase in staleness between the current job and the average staleness of previous jobs with the same query hash. + }, + "tableReference": { # Output only. The table that was queried. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + }, + ], }, "queryInfo": { # Query optimization information for a QUERY job. # Output only. Query optimization information for a QUERY job. "optimizationDetails": { # Output only. Information about query optimizations. @@ -6257,11 +6469,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -6659,11 +6883,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -6923,11 +7159,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -7144,6 +7392,9 @@Method Details
}, "functionStats": [ # Function level stats for GenAi Functions. See https://docs.cloud.google.com/bigquery/docs/generative-ai-overview { # Provides statistics for each Ai function call within a query. + "cacheStats": { # Provides cache statistics for a GenAi function call. # Cache stats for the function. + "numCacheHitRows": "A String", # Number of rows served from cache. + }, "costOptimizationStats": { # Provides cost optimization statistics for a GenAi function call. # Cost optimization stats if applied on the rows processed by the function. "message": "A String", # System generated message to provide insights into cost optimization state. "numCostOptimizedRows": "A String", # Number of rows inferred via cost optimized workflow. @@ -7750,6 +8001,20 @@Method Details
"stageId": "A String", # Output only. The stage id that the insight mapped to. }, ], + "tableChangeInsights": [ # Output only. Performance insights for table-level attributes that changed compared to previous runs. + { # Table-level performance insights compared to previous runs. These insights don't apply to specific query stages, rather they apply to the whole table. + "metadataCacheNotUsedButUsedPreviously": True or False, # Output only. True if the table's column metadata index was not used in the current job, but was used in a previous job with the same query hash. + "metadataCacheStalenessInsight": { # Column Metadata Index staleness detailed infnormation. # Output only. If present, indicates that the table's metadata column index staleness has increased significantly compared to previous jobs with the same query hash. + "avgPreviousStalenessMs": "A String", # Output only. Average column metadata index staleness of previous runs with the same query hash. + "stalenessPercentageIncrease": 3.14, # Output only. The percent increase in staleness between the current job and the average staleness of previous jobs with the same query hash. + }, + "tableReference": { # Output only. The table that was queried. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + }, + ], }, "queryInfo": { # Query optimization information for a QUERY job. # Output only. Query optimization information for a QUERY job. "optimizationDetails": { # Output only. Information about query optimizations. @@ -7836,11 +8101,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -8224,11 +8501,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. diff --git a/docs/dyn/bigquery_v2.routines.html b/docs/dyn/bigquery_v2.routines.html index 8e9090dba6..67a38c32e9 100644 --- a/docs/dyn/bigquery_v2.routines.html +++ b/docs/dyn/bigquery_v2.routines.html @@ -185,6 +185,7 @@Method Details
"externalRuntimeOptions": { # Options for the runtime of the external system. # Optional. Options for the runtime of the external system executing the routine. This field is only applicable for Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) "containerCpu": 3.14, # Optional. Amount of CPU provisioned for a Python UDF container instance. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) "containerMemory": "A String", # Optional. Amount of memory provisioned for a Python UDF container instance. Format: {number}{unit} where unit is one of "M", "G", "Mi" and "Gi" (e.g. 1G, 512Mi). If not specified, the default value is 512Mi. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) + "containerRequestConcurrency": "A String", # Optional. Maximum number of requests that a Cloud Run instance can handle concurrently. If absent or if `0`, a default concurrency is used. "maxBatchingRows": "A String", # Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch. "runtimeConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"``` "runtimeVersion": "A String", # Optional. Language runtime version. Example: `python-3.11`. @@ -371,6 +372,7 @@Method Details
"externalRuntimeOptions": { # Options for the runtime of the external system. # Optional. Options for the runtime of the external system executing the routine. This field is only applicable for Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) "containerCpu": 3.14, # Optional. Amount of CPU provisioned for a Python UDF container instance. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) "containerMemory": "A String", # Optional. Amount of memory provisioned for a Python UDF container instance. Format: {number}{unit} where unit is one of "M", "G", "Mi" and "Gi" (e.g. 1G, 512Mi). If not specified, the default value is 512Mi. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) + "containerRequestConcurrency": "A String", # Optional. Maximum number of requests that a Cloud Run instance can handle concurrently. If absent or if `0`, a default concurrency is used. "maxBatchingRows": "A String", # Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch. "runtimeConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"``` "runtimeVersion": "A String", # Optional. Language runtime version. Example: `python-3.11`. @@ -498,6 +500,7 @@Method Details
"externalRuntimeOptions": { # Options for the runtime of the external system. # Optional. Options for the runtime of the external system executing the routine. This field is only applicable for Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) "containerCpu": 3.14, # Optional. Amount of CPU provisioned for a Python UDF container instance. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) "containerMemory": "A String", # Optional. Amount of memory provisioned for a Python UDF container instance. Format: {number}{unit} where unit is one of "M", "G", "Mi" and "Gi" (e.g. 1G, 512Mi). If not specified, the default value is 512Mi. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) + "containerRequestConcurrency": "A String", # Optional. Maximum number of requests that a Cloud Run instance can handle concurrently. If absent or if `0`, a default concurrency is used. "maxBatchingRows": "A String", # Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch. "runtimeConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"``` "runtimeVersion": "A String", # Optional. Language runtime version. Example: `python-3.11`. @@ -640,6 +643,7 @@Method Details
"externalRuntimeOptions": { # Options for the runtime of the external system. # Optional. Options for the runtime of the external system executing the routine. This field is only applicable for Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) "containerCpu": 3.14, # Optional. Amount of CPU provisioned for a Python UDF container instance. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) "containerMemory": "A String", # Optional. Amount of memory provisioned for a Python UDF container instance. Format: {number}{unit} where unit is one of "M", "G", "Mi" and "Gi" (e.g. 1G, 512Mi). If not specified, the default value is 512Mi. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) + "containerRequestConcurrency": "A String", # Optional. Maximum number of requests that a Cloud Run instance can handle concurrently. If absent or if `0`, a default concurrency is used. "maxBatchingRows": "A String", # Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch. "runtimeConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"``` "runtimeVersion": "A String", # Optional. Language runtime version. Example: `python-3.11`. @@ -902,6 +906,7 @@Method Details
"externalRuntimeOptions": { # Options for the runtime of the external system. # Optional. Options for the runtime of the external system executing the routine. This field is only applicable for Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) "containerCpu": 3.14, # Optional. Amount of CPU provisioned for a Python UDF container instance. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) "containerMemory": "A String", # Optional. Amount of memory provisioned for a Python UDF container instance. Format: {number}{unit} where unit is one of "M", "G", "Mi" and "Gi" (e.g. 1G, 512Mi). If not specified, the default value is 512Mi. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) + "containerRequestConcurrency": "A String", # Optional. Maximum number of requests that a Cloud Run instance can handle concurrently. If absent or if `0`, a default concurrency is used. "maxBatchingRows": "A String", # Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch. "runtimeConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"``` "runtimeVersion": "A String", # Optional. Language runtime version. Example: `python-3.11`. @@ -1029,6 +1034,7 @@Method Details
"externalRuntimeOptions": { # Options for the runtime of the external system. # Optional. Options for the runtime of the external system executing the routine. This field is only applicable for Python UDFs. [Preview](https://cloud.google.com/products/#product-launch-stages) "containerCpu": 3.14, # Optional. Amount of CPU provisioned for a Python UDF container instance. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) "containerMemory": "A String", # Optional. Amount of memory provisioned for a Python UDF container instance. Format: {number}{unit} where unit is one of "M", "G", "Mi" and "Gi" (e.g. 1G, 512Mi). If not specified, the default value is 512Mi. For more information, see [Configure container limits for Python UDFs](https://cloud.google.com/bigquery/docs/user-defined-functions-python#configure-container-limits) + "containerRequestConcurrency": "A String", # Optional. Maximum number of requests that a Cloud Run instance can handle concurrently. If absent or if `0`, a default concurrency is used. "maxBatchingRows": "A String", # Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch. "runtimeConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"``` "runtimeVersion": "A String", # Optional. Language runtime version. Example: `python-3.11`. diff --git a/docs/dyn/bigquery_v2.tables.html b/docs/dyn/bigquery_v2.tables.html index a43b26573c..885c4ec298 100644 --- a/docs/dyn/bigquery_v2.tables.html +++ b/docs/dyn/bigquery_v2.tables.html @@ -291,11 +291,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -456,11 +468,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -812,11 +836,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -977,11 +1013,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -1274,11 +1322,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -1439,11 +1499,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -1844,11 +1916,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -2009,11 +2093,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -2307,11 +2403,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -2472,11 +2580,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -2888,11 +3008,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -3053,11 +3185,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -3351,11 +3495,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. @@ -3516,11 +3672,23 @@Method Details
], }, "collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. + "dataGovernanceTagsInfo": { # Optional. Specifies the data governance tags on this field. This field works with other column-level security fields as follows: - Precedence: If a data governance tag is attached to a column, it takes precedence over the policy tag attached to the column. However, if a data policy is attached to a column, it takes precedence over the data governance tag. - Patching behavior (how this field behaves during a `Table.patch` schema update): - Unset: If the `data_governance_tags_info` field is omitted from the update request, the existing tags on the column are preserved. - Empty Field: To clear data governance tags from a column, send the `data_governance_tags_info` field as an empty object. This will remove all tags from the column. - Updating tags: To replace existing tag, send the field with the new tag. + "dataGovernanceTags": { # Optional. The data governance tags added to this field are used for field-level access control. Only one data governance tag is currently supported on a field. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/pii" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "sensitive". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. For example: "123456789012/pii": "sensitive", "myProject/cost_center": "sales" + "a_key": "A String", + }, + }, "dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control. { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. }, ], + "dataPolicyList": { # A list of data policy options. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). # Optional. Specifies data policies attached to this field, used for field-level access control. When set, this will be the source of truth for data policy information. + "dataPolicies": [ # Contains a list of data policy options. At most 9 data policies are allowed per field. + { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column). + "name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + }, + ], + }, "defaultValueExpression": "A String", # Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. "description": "A String", # Optional. The field description. The maximum length is 1,024 characters. "fields": [ # Optional. Describes the nested schema fields if the type property is set to RECORD. diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html index c899763fac..52018bcb2f 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html @@ -186,7 +186,7 @@Method Details
"table": { # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. # Required. The Table to create. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. - "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances. + "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. You can set this field only for tables in Enterprise Plus instances. "A String", ], "retentionPeriod": "A String", # Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days. @@ -407,7 +407,7 @@Method Details
{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. - "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances. + "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. You can set this field only for tables in Enterprise Plus instances. "A String", ], "retentionPeriod": "A String", # Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days. @@ -711,7 +711,7 @@Method Details
{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. - "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances. + "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. You can set this field only for tables in Enterprise Plus instances. "A String", ], "retentionPeriod": "A String", # Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days. @@ -1007,7 +1007,7 @@Method Details
{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. - "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances. + "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. You can set this field only for tables in Enterprise Plus instances. "A String", ], "retentionPeriod": "A String", # Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days. @@ -1533,7 +1533,7 @@Method Details
{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. - "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances. + "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. You can set this field only for tables in Enterprise Plus instances. "A String", ], "retentionPeriod": "A String", # Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days. @@ -1754,7 +1754,7 @@Method Details
{ # A collection of user data indexed by row, column, and timestamp. Each table is served using the resources of its parent cluster. "automatedBackupPolicy": { # Defines an automated backup policy for a table # If specified, automated backups are enabled for this table. Otherwise, automated backups are disabled. "frequency": "A String", # How frequently automated backups should occur. The only supported value at this time is 24 hours. An undefined frequency is treated as 24 hours. - "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. This field can only set for tables in Enterprise Plus instances. + "locations": [ # Optional. A list of Cloud Bigtable zones where automated backups are allowed to be created. If empty, automated backups will be created in all zones of the instance. Locations are in the format `projects/{project}/locations/{zone}`. You can set this field only for tables in Enterprise Plus instances. "A String", ], "retentionPeriod": "A String", # Required. How long the automated backups should be retained. Values must be at least 3 days and at most 90 days. diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.schemaBundles.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.schemaBundles.html index 0febadc908..83367f7658 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.schemaBundles.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.schemaBundles.html @@ -122,7 +122,7 @@Method Details
{ # A named collection of related schemas. "etag": "A String", # Optional. The etag for this schema bundle. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. "name": "A String", # Identifier. The unique name identifying this schema bundle. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}` - "protoSchema": { # Represents a protobuf schema. # Schema for Protobufs. + "protoSchema": { # Represents a collection of protobuf schemas. # Schema for Protobufs. "protoDescriptors": "A String", # Required. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto), which could include multiple proto files. 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.pb \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). }, } @@ -193,7 +193,7 @@Method Details
{ # A named collection of related schemas. "etag": "A String", # Optional. The etag for this schema bundle. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. "name": "A String", # Identifier. The unique name identifying this schema bundle. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}` - "protoSchema": { # Represents a protobuf schema. # Schema for Protobufs. + "protoSchema": { # Represents a collection of protobuf schemas. # Schema for Protobufs. "protoDescriptors": "A String", # Required. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto), which could include multiple proto files. 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.pb \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). }, }Method Details
{ # A named collection of related schemas. "etag": "A String", # Optional. The etag for this schema bundle. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. "name": "A String", # Identifier. The unique name identifying this schema bundle. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}` - "protoSchema": { # Represents a protobuf schema. # Schema for Protobufs. + "protoSchema": { # Represents a collection of protobuf schemas. # Schema for Protobufs. "protoDescriptors": "A String", # Required. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto), which could include multiple proto files. 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.pb \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). }, }, @@ -317,7 +317,7 @@Method Details
{ # A named collection of related schemas. "etag": "A String", # Optional. The etag for this schema bundle. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. The server returns an ABORTED error on a mismatched etag. "name": "A String", # Identifier. The unique name identifying this schema bundle. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}` - "protoSchema": { # Represents a protobuf schema. # Schema for Protobufs. + "protoSchema": { # Represents a collection of protobuf schemas. # Schema for Protobufs. "protoDescriptors": "A String", # Required. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto), which could include multiple proto files. 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.pb \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). }, } diff --git a/docs/dyn/blogger_v3.blogUserInfos.html b/docs/dyn/blogger_v3.blogUserInfos.html index ae83467953..0ae0d2a9ef 100644 --- a/docs/dyn/blogger_v3.blogUserInfos.html +++ b/docs/dyn/blogger_v3.blogUserInfos.html @@ -72,7 +72,7 @@ -Blogger API . blogUserInfos
+blogger API . blogUserInfos
Instance Methods
diff --git a/docs/dyn/blogger_v3.blogs.html b/docs/dyn/blogger_v3.blogs.html index 2652132339..00783a7f28 100644 --- a/docs/dyn/blogger_v3.blogs.html +++ b/docs/dyn/blogger_v3.blogs.html @@ -72,7 +72,7 @@ -Blogger API . blogs
+blogger API . blogs
Instance Methods
diff --git a/docs/dyn/blogger_v3.comments.html b/docs/dyn/blogger_v3.comments.html index 880f66cf76..0759b2a0ec 100644 --- a/docs/dyn/blogger_v3.comments.html +++ b/docs/dyn/blogger_v3.comments.html @@ -72,7 +72,7 @@ -Blogger API . comments
+blogger API . comments
Instance Methods
diff --git a/docs/dyn/blogger_v3.html b/docs/dyn/blogger_v3.html index 9f14da132f..7fa99faec2 100644 --- a/docs/dyn/blogger_v3.html +++ b/docs/dyn/blogger_v3.html @@ -72,7 +72,7 @@ -
approve(blogId, postId, commentId, x__xgafv=None)Blogger API
+blogger API
Instance Methods
blogUserInfos()diff --git a/docs/dyn/blogger_v3.pageViews.html b/docs/dyn/blogger_v3.pageViews.html index 81fc3cd4dd..bf73a5e101 100644 --- a/docs/dyn/blogger_v3.pageViews.html +++ b/docs/dyn/blogger_v3.pageViews.html @@ -72,7 +72,7 @@ -Blogger API . pageViews
+blogger API . pageViews
Instance Methods
diff --git a/docs/dyn/blogger_v3.pages.html b/docs/dyn/blogger_v3.pages.html index 6ee70433c0..306cd8055c 100644 --- a/docs/dyn/blogger_v3.pages.html +++ b/docs/dyn/blogger_v3.pages.html @@ -72,7 +72,7 @@ -Blogger API . pages
+blogger API . pages
Instance Methods
diff --git a/docs/dyn/blogger_v3.postUserInfos.html b/docs/dyn/blogger_v3.postUserInfos.html index 3a32ba2537..bea92d50de 100644 --- a/docs/dyn/blogger_v3.postUserInfos.html +++ b/docs/dyn/blogger_v3.postUserInfos.html @@ -72,7 +72,7 @@ -Blogger API . postUserInfos
+blogger API . postUserInfos
Instance Methods
diff --git a/docs/dyn/blogger_v3.posts.html b/docs/dyn/blogger_v3.posts.html index ffd9d2ccf1..44b7c59757 100644 --- a/docs/dyn/blogger_v3.posts.html +++ b/docs/dyn/blogger_v3.posts.html @@ -72,7 +72,7 @@ -Blogger API . posts
+blogger API . posts
Instance Methods
diff --git a/docs/dyn/blogger_v3.users.html b/docs/dyn/blogger_v3.users.html index f92fa607c9..ebbe88e38b 100644 --- a/docs/dyn/blogger_v3.users.html +++ b/docs/dyn/blogger_v3.users.html @@ -72,7 +72,7 @@ -Blogger API . users
+blogger API . users
Instance Methods
diff --git a/docs/dyn/calendar_v3.events.html b/docs/dyn/calendar_v3.events.html index 8f1e38099a..f19b7eec7c 100644 --- a/docs/dyn/calendar_v3.events.html +++ b/docs/dyn/calendar_v3.events.html @@ -173,6 +173,10 @@Method Details
"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -480,6 +484,10 @@Method Details
"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -782,6 +790,10 @@Method Details
"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -1088,6 +1100,10 @@Method Details
"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -1399,6 +1415,10 @@Method Details
"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -1737,6 +1757,10 @@Method Details
"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -2141,6 +2165,10 @@Method Details
"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -2480,6 +2508,10 @@Method Details
"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -2787,6 +2819,10 @@Method Details
"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -3099,6 +3135,10 @@Method Details
"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -3415,6 +3455,10 @@Method Details
"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -3722,6 +3766,10 @@Method Details
"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. @@ -4034,6 +4082,10 @@Method Details
"attendees": [ # The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list. { "additionalGuests": 0, # Number of additional guests. Optional. The default is 0. + "asyncOperation": "", # If present, indicates the status of an asynchronous operation ongoing for this attendee (e.g. listing of members of large attendee groups). Read-only. The default is to not be present. + # Possible values are: + # - "inProgress" - The asynchronous operation is in progress. + # - (not present) - Otherwise. "comment": "A String", # The attendee's response comment. Optional. "displayName": "A String", # The attendee's name, if available. Optional. "email": "A String", # The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. diff --git a/docs/dyn/ces_v1.projects.locations.apps.agents.html b/docs/dyn/ces_v1.projects.locations.apps.agents.html index 079cc020bc..609365d4d6 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.agents.html +++ b/docs/dyn/ces_v1.projects.locations.apps.agents.html @@ -185,6 +185,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -310,6 +311,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -461,6 +463,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -598,6 +601,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -741,6 +745,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -866,6 +871,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, diff --git a/docs/dyn/ces_v1.projects.locations.apps.html b/docs/dyn/ces_v1.projects.locations.apps.html index a5ac1d9dad..1a291b4fc0 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.html +++ b/docs/dyn/ces_v1.projects.locations.apps.html @@ -104,6 +104,11 @@Instance Methods
Returns the guardrails Resource.
++
+message()+Returns the message Resource.
+ @@ -277,11 +282,11 @@Method Details
}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -305,7 +310,7 @@Method Details
"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -710,11 +715,11 @@Method Details
}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -738,7 +743,7 @@Method Details
"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -1021,11 +1026,11 @@Method Details
}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -1049,7 +1054,7 @@Method Details
"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -1292,11 +1297,11 @@Method Details
}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -1320,7 +1325,7 @@Method Details
"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -1542,11 +1547,11 @@Method Details
}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -1570,7 +1575,7 @@Method Details
"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, diff --git a/docs/dyn/ces_v1.projects.locations.apps.message.html b/docs/dyn/ces_v1.projects.locations.apps.message.html new file mode 100644 index 0000000000..2020f5e79d --- /dev/null +++ b/docs/dyn/ces_v1.projects.locations.apps.message.html @@ -0,0 +1,285 @@ + + + +Gemini Enterprise for Customer Experience API . projects . locations . apps . message
+Instance Methods
++
+close()Close httplib2 connections.
++
+send(tenant, body=None, x__xgafv=None)Sends a message to an agent.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/ces_v1.projects.locations.apps.tools.html b/docs/dyn/ces_v1.projects.locations.apps.tools.html index 47017a728b..0b8c21dc97 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.tools.html +++ b/docs/dyn/ces_v1.projects.locations.apps.tools.html @@ -403,6 +403,7 @@send(tenant, body=None, x__xgafv=None)+Sends a message to an agent. + +Args: + tenant: string, Optional. Tenant ID, provided as a path parameter. (required) + body: object, The request body. + The object takes the form of: + +{ # Represents a request for the `SendMessage` method. + "configuration": { # Configuration of a send message request. # Configuration for the send request. + "acceptedOutputModes": [ # A list of media types the client is prepared to accept for response parts. Agents SHOULD use this to tailor their output. + "A String", + ], + "historyLength": 42, # The maximum number of most recent messages from the task's history to retrieve in the response. An unset value means the client does not impose any limit. A value of zero is a request to not include any messages. The server MUST NOT return more messages than the provided value, but MAY apply a lower limit. + "returnImmediately": True or False, # If `true`, the operation returns immediately after creating the task, even if processing is still in progress. If `false` (default), the operation MUST wait until the task reaches a terminal (`COMPLETED`, `FAILED`, `CANCELED`, `REJECTED`) or interrupted (`INPUT_REQUIRED`, `AUTH_REQUIRED`) state before returning. + "taskPushNotificationConfig": { # A container associating a push notification configuration with a specific task. # Configuration for the agent to send push notifications for task updates. Task id should be empty when sending this configuration in a `SendMessage` request. + "authentication": { # Defines authentication details, used for push notifications. # Authentication information required to send the notification. + "credentials": "A String", # Push Notification credentials. Format depends on the scheme (e.g., token for Bearer). + "scheme": "A String", # Required. HTTP Authentication Scheme from the [IANA registry](https://www.iana.org/assignments/http-authschemes/). Examples: `Bearer`, `Basic`, `Digest`. Scheme names are case-insensitive per [RFC 9110 Section 11.1](https://www.rfc-editor.org/rfc/rfc9110#section-11.1). + }, + "id": "A String", # The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration. + "taskId": "A String", # The ID of the task this configuration is associated with. + "tenant": "A String", # Optional. Tenant ID. + "token": "A String", # A token unique for this task or session. + "url": "A String", # Required. The URL where the notification should be sent. + }, + }, + "message": { # `Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it. # Required. The message to send to the agent. + "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context. + "extensions": [ # The URIs of extensions that are present or contributed to this Message. + "A String", + ], + "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator. + "metadata": { # Optional. Any metadata to provide along with the message. + "a_key": "", # Properties of the object. + }, + "parts": [ # Required. Parts is the container of the message content. + { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON). + "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null). + "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf"). + "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types. + "metadata": { # Optional. metadata associated with this part. + "a_key": "", # Properties of the object. + }, + "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string. + "text": "A String", # The string content of the `text` part. + "url": "A String", # A `url` pointing to the file's content. + }, + ], + "referenceTaskIds": [ # A list of task IDs that this message references for additional context. + "A String", + ], + "role": "A String", # Required. Identifies the sender of the message. + "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task. + }, + "metadata": { # A flexible key-value map for passing additional context or parameters. + "a_key": "", # Properties of the object. + }, +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents the response for the `SendMessage` method. + "message": { # `Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it. # A message from the agent. + "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context. + "extensions": [ # The URIs of extensions that are present or contributed to this Message. + "A String", + ], + "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator. + "metadata": { # Optional. Any metadata to provide along with the message. + "a_key": "", # Properties of the object. + }, + "parts": [ # Required. Parts is the container of the message content. + { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON). + "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null). + "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf"). + "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types. + "metadata": { # Optional. metadata associated with this part. + "a_key": "", # Properties of the object. + }, + "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string. + "text": "A String", # The string content of the `text` part. + "url": "A String", # A `url` pointing to the file's content. + }, + ], + "referenceTaskIds": [ # A list of task IDs that this message references for additional context. + "A String", + ], + "role": "A String", # Required. Identifies the sender of the message. + "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task. + }, + "task": { # `Task` is the core unit of action for A2A. It has a current status and when results are created for the task they are stored in the artifact. If there are multiple turns for a task, these are stored in history. # The task created or updated by the message. + "artifacts": [ # A set of output artifacts for a `Task`. + { # Artifacts represent task outputs. + "artifactId": "A String", # Required. Unique identifier (e.g. UUID) for the artifact. It must be unique within a task. + "description": "A String", # Optional. A human readable description of the artifact. + "extensions": [ # The URIs of extensions that are present or contributed to this Artifact. + "A String", + ], + "metadata": { # Optional. Metadata included with the artifact. + "a_key": "", # Properties of the object. + }, + "name": "A String", # A human readable name for the artifact. + "parts": [ # Required. The content of the artifact. Must contain at least one part. + { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON). + "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null). + "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf"). + "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types. + "metadata": { # Optional. metadata associated with this part. + "a_key": "", # Properties of the object. + }, + "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string. + "text": "A String", # The string content of the `text` part. + "url": "A String", # A `url` pointing to the file's content. + }, + ], + }, + ], + "contextId": "A String", # Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages). + "history": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a `Task`. + { # `Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it. + "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context. + "extensions": [ # The URIs of extensions that are present or contributed to this Message. + "A String", + ], + "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator. + "metadata": { # Optional. Any metadata to provide along with the message. + "a_key": "", # Properties of the object. + }, + "parts": [ # Required. Parts is the container of the message content. + { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON). + "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null). + "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf"). + "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types. + "metadata": { # Optional. metadata associated with this part. + "a_key": "", # Properties of the object. + }, + "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string. + "text": "A String", # The string content of the `text` part. + "url": "A String", # A `url` pointing to the file's content. + }, + ], + "referenceTaskIds": [ # A list of task IDs that this message references for additional context. + "A String", + ], + "role": "A String", # Required. Identifies the sender of the message. + "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task. + }, + ], + "id": "A String", # Required. Unique identifier (e.g. UUID) for the task, generated by the server for a new task. + "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task. + "a_key": "", # Properties of the object. + }, + "status": { # A container for the status of a task # Required. The current status of a `Task`, including `state` and a `message`. + "message": { # `Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it. # A message associated with the status. + "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context. + "extensions": [ # The URIs of extensions that are present or contributed to this Message. + "A String", + ], + "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator. + "metadata": { # Optional. Any metadata to provide along with the message. + "a_key": "", # Properties of the object. + }, + "parts": [ # Required. Parts is the container of the message content. + { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON). + "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null). + "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf"). + "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types. + "metadata": { # Optional. metadata associated with this part. + "a_key": "", # Properties of the object. + }, + "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string. + "text": "A String", # The string content of the `text` part. + "url": "A String", # A `url` pointing to the file's content. + }, + ], + "referenceTaskIds": [ # A list of task IDs that this message references for additional context. + "A String", + ], + "role": "A String", # Required. Identifies the sender of the message. + "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task. + }, + "state": "A String", # Required. The current state of this task. + "timestamp": "A String", # ISO 8601 Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z" + }, + }, +}+Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -440,6 +441,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -499,6 +501,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -558,6 +563,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -911,6 +919,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -948,6 +957,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -1007,6 +1017,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -1066,6 +1079,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -1445,6 +1461,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -1482,6 +1499,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -1541,6 +1559,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -1600,6 +1621,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -1966,6 +1990,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -2003,6 +2028,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -2062,6 +2088,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -2121,6 +2150,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -2491,6 +2523,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -2528,6 +2561,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -2587,6 +2621,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -2646,6 +2683,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -2999,6 +3039,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -3036,6 +3077,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -3095,6 +3137,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -3154,6 +3199,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` diff --git a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html index d212b41072..68534ad20d 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html +++ b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html @@ -190,6 +190,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -330,6 +406,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -496,6 +648,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -649,6 +877,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -806,6 +1110,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -946,6 +1326,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -1011,6 +1467,7 @@Method Details
The object takes the form of: { # Request message for ToolService.RetrieveTools. + "bypassPersistenceConfig": True or False, # Optional. If true, the returned tools will contain raw descriptions and schemas directly from the server, bypassing any stored persistence configurations (overrides/snapshots). "toolIds": [ # Optional. The identifiers of the tools to retrieve from the toolset. If empty, all tools in the toolset will be returned. "A String", ], @@ -1319,6 +1776,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -1356,6 +1814,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -1415,6 +1874,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -1474,6 +1936,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` diff --git a/docs/dyn/ces_v1.projects.locations.apps.versions.html b/docs/dyn/ces_v1.projects.locations.apps.versions.html index 147f6b987b..cad1bc4cb7 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1.projects.locations.apps.versions.html @@ -194,6 +194,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -340,11 +341,11 @@Method Details
}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -368,7 +369,7 @@Method Details
"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -940,6 +941,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -977,6 +979,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -1036,6 +1039,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -1095,6 +1101,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -1224,6 +1233,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -1374,6 +1459,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -1520,11 +1606,11 @@Method Details
}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -1548,7 +1634,7 @@Method Details
"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -2120,6 +2206,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -2157,6 +2244,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -2216,6 +2304,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -2275,6 +2366,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -2404,6 +2498,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -2579,6 +2749,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -2725,11 +2896,11 @@Method Details
}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -2753,7 +2924,7 @@Method Details
"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -3325,6 +3496,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -3362,6 +3534,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -3421,6 +3594,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -3480,6 +3656,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -3609,6 +3788,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -3771,6 +4026,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -3917,11 +4173,11 @@Method Details
}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -3945,7 +4201,7 @@Method Details
"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -4517,6 +4773,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -4554,6 +4811,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -4613,6 +4871,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -4672,6 +4933,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -4801,6 +5065,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.agents.html b/docs/dyn/ces_v1beta.projects.locations.apps.agents.html index 7423a7d144..204ef8a141 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.agents.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.agents.html @@ -185,6 +185,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -310,6 +311,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -461,6 +463,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -598,6 +601,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -741,6 +745,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -866,6 +871,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.evaluationRuns.html b/docs/dyn/ces_v1beta.projects.locations.apps.evaluationRuns.html index 57b352d4dc..98d9e46d85 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluationRuns.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluationRuns.html @@ -228,6 +228,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationDataset": "A String", # Output only. The evaluation dataset that this run is associated with. This field is mutually exclusive with `evaluations`. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}` "evaluationResults": [ # Output only. The evaluation results that are part of this run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}` @@ -300,6 +301,7 @@Method Details
], }, "name": "A String", # Identifier. The unique identifier of the evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}` + "operation": "A String", # Output only. The operation that created this evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation}` "optimizationConfig": { # Configuration for running the optimization step after the evaluation run. # Optional. Configuration for running the optimization step after the evaluation run. If not set, the optimization step will not be run. "assistantSession": "A String", # Output only. The assistant session to use for the optimization based on this evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}` "errorMessage": "A String", # Output only. The error message if the optimization run failed. @@ -383,6 +385,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationDataset": "A String", # Output only. The evaluation dataset that this run is associated with. This field is mutually exclusive with `evaluations`. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}` "evaluationResults": [ # Output only. The evaluation results that are part of this run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}` @@ -455,6 +458,7 @@Method Details
], }, "name": "A String", # Identifier. The unique identifier of the evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}` + "operation": "A String", # Output only. The operation that created this evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation}` "optimizationConfig": { # Configuration for running the optimization step after the evaluation run. # Optional. Configuration for running the optimization step after the evaluation run. If not set, the optimization step will not be run. "assistantSession": "A String", # Output only. The assistant session to use for the optimization based on this evaluation run. Format: `projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}` "errorMessage": "A String", # Output only. The error message if the optimization run failed. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html index b6bca7bc5f..60549d12de 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html @@ -458,6 +458,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -496,6 +497,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -1043,6 +1045,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -1081,6 +1084,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -2055,6 +2059,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -2093,6 +2098,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -2640,6 +2646,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -2678,6 +2685,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -3728,6 +3736,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -3766,6 +3775,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -4313,6 +4323,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -4351,6 +4362,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -5340,6 +5352,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -5378,6 +5391,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -5925,6 +5939,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -5963,6 +5978,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -6955,6 +6971,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -6993,6 +7010,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -7540,6 +7558,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -7578,6 +7597,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -8552,6 +8572,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -8590,6 +8611,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -9137,6 +9159,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -9175,6 +9198,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html index 7b995601eb..1506eec291 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html @@ -211,6 +211,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -249,6 +250,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. @@ -817,6 +819,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "evaluationMetricsThresholds": { # Threshold settings for metrics in an Evaluation. # Output only. The evaluation thresholds for the result. "goldenEvaluationMetricsThresholds": { # Settings for golden evaluations. # Optional. The golden evaluation metrics thresholds. @@ -855,6 +858,7 @@Method Details
"errorMessage": "A String", # Output only. The error message. "errorType": "A String", # Output only. The type of error. "sessionId": "A String", # Output only. The session ID for the conversation that caused the error. + "userFacingErrorMessage": "A String", # Output only. The user facing error message. }, "expectationOutcome": [ # Output only. The outcome of each expectation. { # Specifies the expectation and the result of that expectation. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.html b/docs/dyn/ces_v1beta.projects.locations.apps.html index 312890b074..8657932d4e 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.html @@ -124,6 +124,11 @@Instance Methods
Returns the guardrails Resource.
++
+message()+Returns the message Resource.
+ @@ -354,11 +359,11 @@Method Details
}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -382,7 +387,7 @@Method Details
"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -753,6 +758,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -1143,6 +1149,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -1180,6 +1187,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -1239,6 +1247,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -1298,6 +1309,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -1448,6 +1462,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -1691,11 +1781,11 @@Method Details
}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -1719,7 +1809,7 @@Method Details
"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -2093,11 +2183,11 @@Method Details
}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -2121,7 +2211,7 @@Method Details
"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -2404,11 +2494,11 @@Method Details
}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -2432,7 +2522,7 @@Method Details
"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -2694,11 +2784,11 @@Method Details
}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -2722,7 +2812,7 @@Method Details
"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.message.html b/docs/dyn/ces_v1beta.projects.locations.apps.message.html new file mode 100644 index 0000000000..c0742277a5 --- /dev/null +++ b/docs/dyn/ces_v1beta.projects.locations.apps.message.html @@ -0,0 +1,285 @@ + + + +Gemini Enterprise for Customer Experience API . projects . locations . apps . message
+Instance Methods
++
+close()Close httplib2 connections.
++
+send(tenant, body=None, x__xgafv=None)Sends a message to an agent.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html index 211c230b68..256b01a495 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html @@ -403,6 +403,7 @@send(tenant, body=None, x__xgafv=None)+Sends a message to an agent. + +Args: + tenant: string, Optional. Tenant ID, provided as a path parameter. (required) + body: object, The request body. + The object takes the form of: + +{ # Represents a request for the `SendMessage` method. + "configuration": { # Configuration of a send message request. # Configuration for the send request. + "acceptedOutputModes": [ # A list of media types the client is prepared to accept for response parts. Agents SHOULD use this to tailor their output. + "A String", + ], + "historyLength": 42, # The maximum number of most recent messages from the task's history to retrieve in the response. An unset value means the client does not impose any limit. A value of zero is a request to not include any messages. The server MUST NOT return more messages than the provided value, but MAY apply a lower limit. + "returnImmediately": True or False, # If `true`, the operation returns immediately after creating the task, even if processing is still in progress. If `false` (default), the operation MUST wait until the task reaches a terminal (`COMPLETED`, `FAILED`, `CANCELED`, `REJECTED`) or interrupted (`INPUT_REQUIRED`, `AUTH_REQUIRED`) state before returning. + "taskPushNotificationConfig": { # A container associating a push notification configuration with a specific task. # Configuration for the agent to send push notifications for task updates. Task id should be empty when sending this configuration in a `SendMessage` request. + "authentication": { # Defines authentication details, used for push notifications. # Authentication information required to send the notification. + "credentials": "A String", # Push Notification credentials. Format depends on the scheme (e.g., token for Bearer). + "scheme": "A String", # Required. HTTP Authentication Scheme from the [IANA registry](https://www.iana.org/assignments/http-authschemes/). Examples: `Bearer`, `Basic`, `Digest`. Scheme names are case-insensitive per [RFC 9110 Section 11.1](https://www.rfc-editor.org/rfc/rfc9110#section-11.1). + }, + "id": "A String", # The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration. + "taskId": "A String", # The ID of the task this configuration is associated with. + "tenant": "A String", # Optional. Tenant ID. + "token": "A String", # A token unique for this task or session. + "url": "A String", # Required. The URL where the notification should be sent. + }, + }, + "message": { # `Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it. # Required. The message to send to the agent. + "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context. + "extensions": [ # The URIs of extensions that are present or contributed to this Message. + "A String", + ], + "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator. + "metadata": { # Optional. Any metadata to provide along with the message. + "a_key": "", # Properties of the object. + }, + "parts": [ # Required. Parts is the container of the message content. + { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON). + "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null). + "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf"). + "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types. + "metadata": { # Optional. metadata associated with this part. + "a_key": "", # Properties of the object. + }, + "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string. + "text": "A String", # The string content of the `text` part. + "url": "A String", # A `url` pointing to the file's content. + }, + ], + "referenceTaskIds": [ # A list of task IDs that this message references for additional context. + "A String", + ], + "role": "A String", # Required. Identifies the sender of the message. + "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task. + }, + "metadata": { # A flexible key-value map for passing additional context or parameters. + "a_key": "", # Properties of the object. + }, +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents the response for the `SendMessage` method. + "message": { # `Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it. # A message from the agent. + "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context. + "extensions": [ # The URIs of extensions that are present or contributed to this Message. + "A String", + ], + "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator. + "metadata": { # Optional. Any metadata to provide along with the message. + "a_key": "", # Properties of the object. + }, + "parts": [ # Required. Parts is the container of the message content. + { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON). + "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null). + "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf"). + "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types. + "metadata": { # Optional. metadata associated with this part. + "a_key": "", # Properties of the object. + }, + "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string. + "text": "A String", # The string content of the `text` part. + "url": "A String", # A `url` pointing to the file's content. + }, + ], + "referenceTaskIds": [ # A list of task IDs that this message references for additional context. + "A String", + ], + "role": "A String", # Required. Identifies the sender of the message. + "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task. + }, + "task": { # `Task` is the core unit of action for A2A. It has a current status and when results are created for the task they are stored in the artifact. If there are multiple turns for a task, these are stored in history. # The task created or updated by the message. + "artifacts": [ # A set of output artifacts for a `Task`. + { # Artifacts represent task outputs. + "artifactId": "A String", # Required. Unique identifier (e.g. UUID) for the artifact. It must be unique within a task. + "description": "A String", # Optional. A human readable description of the artifact. + "extensions": [ # The URIs of extensions that are present or contributed to this Artifact. + "A String", + ], + "metadata": { # Optional. Metadata included with the artifact. + "a_key": "", # Properties of the object. + }, + "name": "A String", # A human readable name for the artifact. + "parts": [ # Required. The content of the artifact. Must contain at least one part. + { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON). + "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null). + "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf"). + "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types. + "metadata": { # Optional. metadata associated with this part. + "a_key": "", # Properties of the object. + }, + "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string. + "text": "A String", # The string content of the `text` part. + "url": "A String", # A `url` pointing to the file's content. + }, + ], + }, + ], + "contextId": "A String", # Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages). + "history": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a `Task`. + { # `Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it. + "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context. + "extensions": [ # The URIs of extensions that are present or contributed to this Message. + "A String", + ], + "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator. + "metadata": { # Optional. Any metadata to provide along with the message. + "a_key": "", # Properties of the object. + }, + "parts": [ # Required. Parts is the container of the message content. + { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON). + "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null). + "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf"). + "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types. + "metadata": { # Optional. metadata associated with this part. + "a_key": "", # Properties of the object. + }, + "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string. + "text": "A String", # The string content of the `text` part. + "url": "A String", # A `url` pointing to the file's content. + }, + ], + "referenceTaskIds": [ # A list of task IDs that this message references for additional context. + "A String", + ], + "role": "A String", # Required. Identifies the sender of the message. + "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task. + }, + ], + "id": "A String", # Required. Unique identifier (e.g. UUID) for the task, generated by the server for a new task. + "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task. + "a_key": "", # Properties of the object. + }, + "status": { # A container for the status of a task # Required. The current status of a `Task`, including `state` and a `message`. + "message": { # `Message` is one unit of communication between client and server. It can be associated with a context and/or a task. For server messages, `context_id` must be provided, and `task_id` only if a task was created. For client messages, both fields are optional, with the caveat that if both are provided, they have to match (the `context_id` has to be the one that is set on the task). If only `task_id` is provided, the server will infer `context_id` from it. # A message associated with the status. + "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context. + "extensions": [ # The URIs of extensions that are present or contributed to this Message. + "A String", + ], + "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator. + "metadata": { # Optional. Any metadata to provide along with the message. + "a_key": "", # Properties of the object. + }, + "parts": [ # Required. Parts is the container of the message content. + { # `Part` represents a container for a section of communication content. Parts can be purely textual, some sort of file (image, video, etc) or a structured data blob (i.e. JSON). + "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null). + "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf"). + "mediaType": "A String", # The `media_type` (MIME type) of the part content (e.g., "text/plain", "application/json", "image/png"). This field is available for all part types. + "metadata": { # Optional. metadata associated with this part. + "a_key": "", # Properties of the object. + }, + "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string. + "text": "A String", # The string content of the `text` part. + "url": "A String", # A `url` pointing to the file's content. + }, + ], + "referenceTaskIds": [ # A list of task IDs that this message references for additional context. + "A String", + ], + "role": "A String", # Required. Identifies the sender of the message. + "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task. + }, + "state": "A String", # Required. The current state of this task. + "timestamp": "A String", # ISO 8601 Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z" + }, + }, +}+Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -440,6 +441,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -499,6 +501,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -558,6 +563,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -911,6 +919,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -948,6 +957,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -1007,6 +1017,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -1066,6 +1079,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -1445,6 +1461,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -1482,6 +1499,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -1541,6 +1559,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -1600,6 +1621,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -1966,6 +1990,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -2003,6 +2028,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -2062,6 +2088,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -2121,6 +2150,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -2491,6 +2523,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -2528,6 +2561,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -2587,6 +2621,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -2646,6 +2683,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -2999,6 +3039,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -3036,6 +3077,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -3095,6 +3137,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -3154,6 +3199,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html index 77db71a499..747e2560bb 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html @@ -190,6 +190,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -330,6 +406,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -496,6 +648,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -649,6 +877,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -806,6 +1110,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -946,6 +1326,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -1011,6 +1467,7 @@Method Details
The object takes the form of: { # Request message for ToolService.RetrieveTools. + "bypassPersistenceConfig": True or False, # Optional. If true, the returned tools will contain raw descriptions and schemas directly from the server, bypassing any stored persistence configurations (overrides/snapshots). "toolIds": [ # Optional. The identifiers of the tools to retrieve from the toolset. If empty, all tools in the toolset will be returned. "A String", ], @@ -1319,6 +1776,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -1356,6 +1814,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -1415,6 +1874,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -1474,6 +1936,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html index fb79646571..3dab947b2d 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html @@ -194,6 +194,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -380,11 +381,11 @@Method Details
}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -408,7 +409,7 @@Method Details
"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -980,6 +981,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -1017,6 +1019,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -1076,6 +1079,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -1135,6 +1141,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -1264,6 +1273,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -1414,6 +1499,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -1600,11 +1686,11 @@Method Details
}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -1628,7 +1714,7 @@Method Details
"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -2200,6 +2286,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -2237,6 +2324,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -2296,6 +2384,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -2355,6 +2446,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -2484,6 +2578,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -2659,6 +2829,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -2845,11 +3016,11 @@Method Details
}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -2873,7 +3044,7 @@Method Details
"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -3445,6 +3616,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -3482,6 +3654,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -3541,6 +3714,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -3600,6 +3776,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -3729,6 +3908,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. @@ -3891,6 +4146,7 @@Method Details
"inputVariableMapping": { # Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. "a_key": "A String", }, + "languageCodeVariable": "A String", # Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. "outputVariableMapping": { # Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. "a_key": "A String", }, @@ -4077,11 +4333,11 @@Method Details
}, "locked": True or False, # Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. "loggingSettings": { # Settings to describe the logging behaviors for the app. # Optional. Logging settings of the app. - "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. + "audioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in RedactionConfig. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, - "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Settings to describe the BigQuery export behaviors for the app. The conversation data will be exported to BigQuery tables if it is enabled. + "bigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in RedactionConfig. "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. "project": "A String", # Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. @@ -4105,7 +4361,7 @@Method Details
"enableRedaction": True or False, # Optional. If true, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. "inspectTemplate": "A String", # Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` }, - "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures recording of unredacted audio. Use this to maintain a raw backup with restricted access when audio redaction is enabled, typically for auditing or monitoring purposes. + "unredactedAudioRecordingConfig": { # Configuration for how the audio interactions should be recorded. # Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is enabled, typically for auditing or monitoring purposes. "gcsBucket": "A String", # Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-@gcp-sa-ces.iam.gserviceaccount.com`. "gcsPathPrefix": "A String", # Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. }, @@ -4677,6 +4933,7 @@Method Details
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. }, "name": "A String", # Required. The name of the MCP tool. + "nameOverride": "A String", # Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Optional. The schema of the output arguments of the MCP tool. "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. @@ -4714,6 +4971,7 @@Method Details
"serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. }, + "state": "A String", # Output only. The dynamic availability state of the tool on the external server. "tlsConfig": { # The TLS configuration. # Optional. The TLS configuration. Includes the custom server certificates that the client should trust. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. { # The CA certificate. @@ -4773,6 +5031,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "remoteAgentTool": { # Represents a tool that allows the agent to call another remote agent. # Optional. The remote agent tool. "agentCard": { # AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol https://a2a-protocol.org/dev/specification/#441-agentcard # Required. The agent card of the remote agent that this tool invokes. @@ -4832,6 +5093,9 @@Method Details
"description": "A String", # Output only. The description of the Python function, parsed from the python code's docstring. "name": "A String", # Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. "pythonCode": "A String", # Optional. The Python code to execute for the tool. + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration for the tool. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. + }, }, "pythonScript": "A String", # Deprecated: Use `python_function` instead. "sourceToolName": "A String", # Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` @@ -4961,6 +5225,82 @@Method Details
}, ], }, + "toolOverrides": [ # Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. + { # Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server. + "descriptionOverride": "A String", # Optional. If present, this tool uses this description instead of the original description from the server. + "nameOverride": "A String", # Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. + "snapshot": { # Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden. # Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. + "description": "A String", # Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. + "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the input arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Output only. The schema of the output arguments of the MCP tool. + "additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. + "a_key": # Object with schema name: Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "items": # Object with schema name: Schema # Optional. Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maximum": 3.14, # Optional. Maximum value for Type.INTEGER and Type.NUMBER. + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minimum": 3.14, # Optional. Minimum value for Type.INTEGER and Type.NUMBER. + "nullable": True or False, # Optional. Indicates if the value may be null. + "prefixItems": [ # Optional. Schemas of initial elements of Type.ARRAY. + # Object with schema name: Schema + ], + "properties": { # Optional. Properties of Type.OBJECT. + "a_key": # Object with schema name: Schema + }, + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring. + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the schema. + "type": "A String", # Required. The type of the data. + "uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. + }, + }, + "tool": "A String", # Required. The original name of the tool as it is emitted by the MCP server. + }, + ], }, "name": "A String", # Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` "openApiToolset": { # A toolset that contains a list of tools that are defined by an OpenAPI schema. # Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. diff --git a/docs/dyn/chromemanagement_v1.customers.enterprise.html b/docs/dyn/chromemanagement_v1.customers.enterprise.html new file mode 100644 index 0000000000..7927d0602e --- /dev/null +++ b/docs/dyn/chromemanagement_v1.customers.enterprise.html @@ -0,0 +1,91 @@ + + + +Chrome Management API . customers . enterprise
+Instance Methods
+ +Returns the securityInsights Resource.
+ ++
+close()Close httplib2 connections.
+Method Details
+++ + \ No newline at end of file diff --git a/docs/dyn/chromemanagement_v1.customers.enterprise.securityInsights.html b/docs/dyn/chromemanagement_v1.customers.enterprise.securityInsights.html new file mode 100644 index 0000000000..16c4a16f44 --- /dev/null +++ b/docs/dyn/chromemanagement_v1.customers.enterprise.securityInsights.html @@ -0,0 +1,167 @@ + + + +close()+Close httplib2 connections.+Chrome Management API . customers . enterprise . securityInsights
+Instance Methods
++
+checkEnablementStatus(customer, x__xgafv=None)Gets the setting state of the insights feature for the customer.
++
+close()Close httplib2 connections.
++
+disable(customer, body=None, x__xgafv=None)Disables insights for the customer.
++
+enable(customer, body=None, x__xgafv=None)Enables insights for the customer and sets up required chrome connectors.
+Method Details
+++ +checkEnablementStatus(customer, x__xgafv=None)+Gets the setting state of the insights feature for the customer. + +Args: + customer: string, Required. The customer to check the enablement status for. Format: customers/{customer_id} (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response from checking the enablement status of insights for the customer. + "insightsState": "A String", # The state of the insights feature. +}+++ +close()+Close httplib2 connections.+++ +disable(customer, body=None, x__xgafv=None)+Disables insights for the customer. + +Args: + customer: string, Required. The customer to disable insights for. Format: customers/{customer} (required) + body: object, The request body. + The object takes the form of: + +{ # Request to disable insights for the customer. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response from disabling insights for the customer. + "insightsState": "A String", # The state of the insights feature. +}+++ + \ No newline at end of file diff --git a/docs/dyn/chromemanagement_v1.customers.html b/docs/dyn/chromemanagement_v1.customers.html index 3ae579587a..af370e4627 100644 --- a/docs/dyn/chromemanagement_v1.customers.html +++ b/docs/dyn/chromemanagement_v1.customers.html @@ -89,6 +89,11 @@enable(customer, body=None, x__xgafv=None)+Enables insights for the customer and sets up required chrome connectors. + +Args: + customer: string, Required. The customer to enable insights for. Format: customers/{customer} (required) + body: object, The request body. + The object takes the form of: + +{ # Request to enable insights for the customer. + "targetOus": [ # Optional. The Organizational Units to set up required connectors for. Organizational Units are provided as paths relative to root. If this field is not set, connectors will be set up at root OU (as if it were set to ["/"]). Example: ["/corp/sales", "/eng"] + "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 from enabling insights for the customer. + "insightsState": "A String", # The state of the insights feature. +}+Instance Methods
Returns the connectorConfigs Resource.
++
+enterprise()+Returns the enterprise Resource.
+ diff --git a/docs/dyn/chromewebstore_v2.publishers.items.html b/docs/dyn/chromewebstore_v2.publishers.items.html index 4602342485..301e0adc07 100644 --- a/docs/dyn/chromewebstore_v2.publishers.items.html +++ b/docs/dyn/chromewebstore_v2.publishers.items.html @@ -171,6 +171,7 @@Method Details
The object takes the form of: { # Request message for PublishItem. + "blockOnWarnings": True or False, # Optional. When set to true the request will fail if there are any warnings during validation and the details will be included in the error_details. Otherwise warnings are treated as non-blocking and will be ignored for validation but will be included in the response for inspection. Defaults to `false` if unset. "deployInfos": [ # Optional. Additional deploy information including the desired initial percentage rollout. Defaults to the current value saved in the developer dashboard if unset. { # Deployment information for a specific release channel. Used in requests to update deployment parameters. "deployPercentage": 42, # Required. The current deploy percentage for the release channel (nonnegative number between 0 and 100). @@ -192,6 +193,14 @@Method Details
"itemId": "A String", # Output only. The ID of the item. "name": "A String", # The name of the item that was submitted "state": "A String", # Output only. The current state of the submission. + "warningInfo": { # Message containing details on warnings encountered during PublishItem. # Output only. Non-blocking warnings encountered during the request. + "warnings": [ # All warnings encountered during the request. + { # Represents a single warning encountered during the request. + "description": "A String", # A description of the warning. Developers should use this message to understand the warning and take appropriate action to resolve the issue. + "reason": "A String", # The reason for the warning. This is a constant value that identifies the proximate cause of the warning. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. + }, + ], + }, }Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -582,6 +589,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -817,6 +831,13 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -1050,6 +1071,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -1316,6 +1344,13 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -1549,6 +1584,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -1790,6 +1832,13 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -2023,6 +2072,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", diff --git a/docs/dyn/cloudbuild_v1.projects.locations.builds.html b/docs/dyn/cloudbuild_v1.projects.locations.builds.html index 1369e52572..cf86ac8393 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.builds.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.builds.html @@ -348,6 +348,13 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -581,6 +588,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -816,6 +830,13 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -1049,6 +1070,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -1315,6 +1343,13 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -1548,6 +1583,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -1789,6 +1831,13 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -2022,6 +2071,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", diff --git a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html index a364db7cb5..f570cf5ce4 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html @@ -337,6 +337,13 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -570,6 +577,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -988,6 +1002,13 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -1221,6 +1242,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -1667,6 +1695,13 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -1900,6 +1935,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -2330,6 +2372,13 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -2563,6 +2612,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -2998,6 +3054,13 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -3231,6 +3294,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -3651,6 +3721,13 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -3884,6 +3961,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", diff --git a/docs/dyn/cloudbuild_v1.projects.triggers.html b/docs/dyn/cloudbuild_v1.projects.triggers.html index 98b5b8689e..e65a4d2c9e 100644 --- a/docs/dyn/cloudbuild_v1.projects.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.triggers.html @@ -337,6 +337,13 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -570,6 +577,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -988,6 +1002,13 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -1221,6 +1242,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -1667,6 +1695,13 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -1900,6 +1935,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -2330,6 +2372,13 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -2563,6 +2612,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -2999,6 +3055,13 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -3232,6 +3295,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", @@ -3650,6 +3720,13 @@Method Details
"buildStepOutputs": [ # List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable is read-only and can't be substituted. "A String", ], + "buildStepResults": { # Results for build steps. step_id -> + "a_key": { # Results for a build step. + "results": { # Results for a build step. + "a_key": "A String", + }, + }, + }, "genericArtifacts": [ # Output only. Generic artifacts uploaded to Artifact Registry at the end of the build. { # A generic artifact uploaded to Artifact Registry using the GenericArtifact directive. "artifactFingerprint": { # Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. # Output only. The hash of the whole artifact. @@ -3883,6 +3960,13 @@Method Details
"endTime": "A String", # End of time span. "startTime": "A String", # Start of time span. }, + "results": [ # Declaration of results for this build step. + { # StepResult is the declaration of a result for a build step. + "attestationContent": "A String", # Optional. The content of the attestation to be generated. + "attestationType": "A String", # Optional. The type of attestation to be generated. + "name": "A String", # Required. The name of the result. + }, + ], "script": "A String", # A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args. "secretEnv": [ # A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. "A String", diff --git a/docs/dyn/cloudbuild_v2.projects.locations.html b/docs/dyn/cloudbuild_v2.projects.locations.html index 812834db18..a05e85e9a7 100644 --- a/docs/dyn/cloudbuild_v2.projects.locations.html +++ b/docs/dyn/cloudbuild_v2.projects.locations.html @@ -92,7 +92,7 @@Instance Methods
Gets information about a location.
-
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -131,11 +131,11 @@Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)-Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. +Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. Args: name: string, 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. Do not use this field unless explicitly documented otherwise. This is primarily 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/clouddeploy_v1.projects.locations.customTargetTypes.html b/docs/dyn/clouddeploy_v1.projects.locations.customTargetTypes.html index cdaab116e4..463fc7c17d 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.customTargetTypes.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.customTargetTypes.html @@ -166,7 +166,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, "render": { # A Task represents a unit of work that is executed as part of a Job. # Optional. The task responsible for render operations. If not provided then Cloud Deploy will perform its default rendering operation. @@ -181,7 +180,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -324,7 +322,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, "render": { # A Task represents a unit of work that is executed as part of a Job. # Optional. The task responsible for render operations. If not provided then Cloud Deploy will perform its default rendering operation. @@ -339,7 +336,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -466,7 +462,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, "render": { # A Task represents a unit of work that is executed as part of a Job. # Optional. The task responsible for render operations. If not provided then Cloud Deploy will perform its default rendering operation. @@ -481,7 +476,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -569,7 +563,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, "render": { # A Task represents a unit of work that is executed as part of a Job. # Optional. The task responsible for render operations. If not provided then Cloud Deploy will perform its default rendering operation. @@ -584,7 +577,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html index 7e6a60fb38..abacf1bafd 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html @@ -161,7 +161,7 @@Method Details
"createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Optional. Description of the `DeliveryPipeline`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -201,7 +201,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -241,7 +240,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -263,7 +261,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -283,7 +280,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -309,7 +305,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -348,7 +343,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -370,7 +364,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -393,7 +386,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -456,7 +448,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -493,7 +484,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -515,7 +505,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -535,7 +524,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -661,7 +649,7 @@Method Details
"createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Optional. Description of the `DeliveryPipeline`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -701,7 +689,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -741,7 +728,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -763,7 +749,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -783,7 +768,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -809,7 +793,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -848,7 +831,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -870,7 +852,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -893,7 +874,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -956,7 +936,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -993,7 +972,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1015,7 +993,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1035,7 +1012,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1144,7 +1120,7 @@Method Details
"createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Optional. Description of the `DeliveryPipeline`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -1184,7 +1160,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1224,7 +1199,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1246,7 +1220,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1266,7 +1239,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1292,7 +1264,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1331,7 +1302,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1353,7 +1323,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1376,7 +1345,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1439,7 +1407,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1476,7 +1443,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1498,7 +1464,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1518,7 +1483,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1588,7 +1552,7 @@Method Details
"createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Optional. Description of the `DeliveryPipeline`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -1628,7 +1592,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1668,7 +1631,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1690,7 +1652,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1710,7 +1671,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1736,7 +1696,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1775,7 +1734,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1797,7 +1755,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1820,7 +1777,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1883,7 +1839,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1920,7 +1875,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1942,7 +1896,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1962,7 +1915,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2097,7 +2049,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2140,7 +2091,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2162,7 +2112,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2183,7 +2132,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2211,7 +2159,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2254,7 +2201,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2276,7 +2222,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2297,7 +2242,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2326,7 +2270,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2369,7 +2312,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2391,7 +2333,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2412,7 +2353,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2438,7 +2378,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2481,7 +2420,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2503,7 +2441,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2524,7 +2461,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2550,7 +2486,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2593,7 +2528,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2615,7 +2549,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2636,7 +2569,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2662,7 +2594,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2705,7 +2636,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2727,7 +2657,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2748,7 +2677,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2774,7 +2702,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2817,7 +2744,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2839,7 +2765,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2860,7 +2785,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2969,7 +2893,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -3012,7 +2935,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3034,7 +2956,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3055,7 +2976,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3083,7 +3003,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -3126,7 +3045,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3148,7 +3066,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3169,7 +3086,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3198,7 +3114,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -3241,7 +3156,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3263,7 +3177,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3284,7 +3197,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3310,7 +3222,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -3353,7 +3264,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3375,7 +3285,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3396,7 +3305,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3422,7 +3330,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -3465,7 +3372,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3487,7 +3393,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3508,7 +3413,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3534,7 +3438,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -3577,7 +3480,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3599,7 +3501,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3620,7 +3521,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3646,7 +3546,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -3689,7 +3588,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3711,7 +3609,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -3732,7 +3629,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html index 77495399b5..5f64c934b4 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html @@ -246,7 +246,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, "render": { # A Task represents a unit of work that is executed as part of a Job. # Optional. The task responsible for render operations. If not provided then Cloud Deploy will perform its default rendering operation. @@ -261,7 +260,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -293,7 +291,7 @@Method Details
"createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Optional. Description of the `DeliveryPipeline`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -333,7 +331,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -373,7 +370,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -395,7 +391,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -415,7 +410,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -441,7 +435,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -480,7 +473,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -502,7 +494,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -525,7 +516,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -588,7 +578,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -625,7 +614,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -647,7 +635,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -667,7 +654,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -687,7 +673,7 @@Method Details
}, "description": "A String", # Optional. Description of the `Release`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `Release`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`. The `release` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -984,7 +970,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, "render": { # A Task represents a unit of work that is executed as part of a Job. # Optional. The task responsible for render operations. If not provided then Cloud Deploy will perform its default rendering operation. @@ -999,7 +984,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1031,7 +1015,7 @@Method Details
"createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Optional. Description of the `DeliveryPipeline`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -1071,7 +1055,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1111,7 +1094,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1133,7 +1115,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1153,7 +1134,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1179,7 +1159,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1218,7 +1197,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1240,7 +1218,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1263,7 +1240,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1326,7 +1302,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1363,7 +1338,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1385,7 +1359,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1405,7 +1378,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1425,7 +1397,7 @@Method Details
}, "description": "A String", # Optional. Description of the `Release`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `Release`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`. The `release` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -1697,7 +1669,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, "render": { # A Task represents a unit of work that is executed as part of a Job. # Optional. The task responsible for render operations. If not provided then Cloud Deploy will perform its default rendering operation. @@ -1712,7 +1683,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1744,7 +1714,7 @@Method Details
"createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Optional. Description of the `DeliveryPipeline`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `DeliveryPipeline`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}`. The `deliveryPipeline` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` @@ -1784,7 +1754,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1824,7 +1793,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1846,7 +1814,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1866,7 +1833,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1892,7 +1858,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1931,7 +1896,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1953,7 +1917,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1976,7 +1939,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2039,7 +2001,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2076,7 +2037,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2098,7 +2058,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2118,7 +2077,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2138,7 +2096,7 @@Method Details
}, "description": "A String", # Optional. Description of the `Release`. Max length is 255 characters. "etag": "A String", # This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "labels": { # Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + "labels": { # Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. "a_key": "A String", }, "name": "A String", # Identifier. Name of the `Release`. Format is `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`. The `release` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?` diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html index 2f976afbe5..7bd2324c7d 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.html @@ -278,7 +278,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -321,7 +320,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -343,7 +341,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -364,7 +361,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -392,7 +388,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -435,7 +430,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -457,7 +451,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -478,7 +471,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -507,7 +499,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -550,7 +541,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -572,7 +562,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -593,7 +582,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -619,7 +607,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -662,7 +649,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -684,7 +670,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -705,7 +690,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -731,7 +715,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -774,7 +757,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -796,7 +778,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -817,7 +798,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -843,7 +823,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -886,7 +865,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -908,7 +886,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -929,7 +906,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -955,7 +931,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -998,7 +973,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1020,7 +994,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1041,7 +1014,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1181,7 +1153,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1224,7 +1195,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1246,7 +1216,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1267,7 +1236,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1295,7 +1263,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1338,7 +1305,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1360,7 +1326,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1381,7 +1346,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1410,7 +1374,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1453,7 +1416,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1475,7 +1437,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1496,7 +1457,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1522,7 +1482,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1565,7 +1524,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1587,7 +1545,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1608,7 +1565,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1634,7 +1590,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1677,7 +1632,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1699,7 +1653,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1720,7 +1673,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1746,7 +1698,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1789,7 +1740,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1811,7 +1761,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1832,7 +1781,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1858,7 +1806,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -1901,7 +1848,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1923,7 +1869,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -1944,7 +1889,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2087,7 +2031,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2130,7 +2073,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2152,7 +2094,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2173,7 +2114,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2201,7 +2141,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2244,7 +2183,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2266,7 +2204,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2287,7 +2224,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2316,7 +2252,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2359,7 +2294,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2381,7 +2315,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2402,7 +2335,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2428,7 +2360,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2471,7 +2402,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2493,7 +2423,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2514,7 +2443,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2540,7 +2468,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2583,7 +2510,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2605,7 +2531,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2626,7 +2551,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2652,7 +2576,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2695,7 +2618,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2717,7 +2639,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2738,7 +2659,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2764,7 +2684,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -2807,7 +2726,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2829,7 +2747,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], @@ -2850,7 +2767,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, ], diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html index 175365a62d..7cbec0284c 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.rollouts.jobRuns.html @@ -159,7 +159,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, @@ -321,7 +320,6 @@Method Details
"a_key": "A String", }, "image": "A String", # Required. Image is the container image to use. - "script": "A String", # Optional. Shell script to execute. If provided then command and args cannot be specified. }, }, }, diff --git a/docs/dyn/cloudidentity_v1.policies.html b/docs/dyn/cloudidentity_v1.policies.html index dbd1ec446f..3e07f240fa 100644 --- a/docs/dyn/cloudidentity_v1.policies.html +++ b/docs/dyn/cloudidentity_v1.policies.html @@ -229,7 +229,7 @@Method Details
List policies. Args: - filter: string, Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.type.matches('^settings/gmail\\..*$') Policies can be filtered by setting type with this expression: setting.type.matches('^.*\\.service_status$') A maximum of one of the above setting.type clauses can be used. Policies can be filtered by customer with this expression: customer == "customers/{customer}" Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. A maximum of one customer clause can be used. The above clauses can only be combined together in a single filter expression with the `&&` operator. + filter: string, Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.type.matches('^settings/gmail\\..*$') Policies can be filtered by setting type with this expression: setting.type.matches('^.*\\.service_status$') Policies can be filtered by customer with this expression: customer == "customers/{customer}" Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. You may only filter on policies for a single customer at a time. The above clauses can be combined together in a single filter expression with the `&&` and `||` operators, like in the following example: customer == "customers/my_customer" && ( setting.type.matches('^settings/gmail\\..*$') || setting.type.matches('^.*\\.service_status$') ) pageSize: integer, Optional. The maximum number of results to return. The service can return fewer than this number. If omitted or set to 0, the default is 50 results per page. The maximum allowed value is 100. `page_size` values greater than 100 default to 100. pageToken: string, Optional. The pagination token received from a prior call to PoliciesService.ListPolicies to retrieve the next page of results. When paginating, all other parameters provided to `ListPoliciesRequest` must match the call that provided the page token. x__xgafv: string, V1 error format. diff --git a/docs/dyn/cloudidentity_v1beta1.policies.html b/docs/dyn/cloudidentity_v1beta1.policies.html index 962675c3f9..f827073b27 100644 --- a/docs/dyn/cloudidentity_v1beta1.policies.html +++ b/docs/dyn/cloudidentity_v1beta1.policies.html @@ -229,7 +229,7 @@Method Details
List policies. Args: - filter: string, Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.type.matches('^settings/gmail\\..*$') Policies can be filtered by setting type with this expression: setting.type.matches('^.*\\.service_status$') A maximum of one of the above setting.type clauses can be used. Policies can be filtered by customer with this expression: customer == "customers/{customer}" Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. A maximum of one customer clause can be used. The above clauses can only be combined together in a single filter expression with the `&&` operator. + filter: string, Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.type.matches('^settings/gmail\\..*$') Policies can be filtered by setting type with this expression: setting.type.matches('^.*\\.service_status$') Policies can be filtered by customer with this expression: customer == "customers/{customer}" Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. You may only filter on policies for a single customer at a time. The above clauses can be combined together in a single filter expression with the `&&` and `||` operators, like in the following example: customer == "customers/my_customer" && ( setting.type.matches('^settings/gmail\\..*$') || setting.type.matches('^.*\\.service_status$') ) pageSize: integer, Optional. The maximum number of results to return. The service can return fewer than this number. If omitted or set to 0, the default is 50 results per page. The maximum allowed value is 100. `page_size` values greater than 100 default to 100. pageToken: string, Optional. The pagination token received from a prior call to PoliciesService.ListPolicies to retrieve the next page of results. When paginating, all other parameters provided to `ListPoliciesRequest` must match the call that provided the page token. x__xgafv: string, V1 error format. diff --git a/docs/dyn/cloudkms_v1.projects.locations.keyRings.importJobs.html b/docs/dyn/cloudkms_v1.projects.locations.keyRings.importJobs.html index c8087e05ef..1a9457bb34 100644 --- a/docs/dyn/cloudkms_v1.projects.locations.keyRings.importJobs.html +++ b/docs/dyn/cloudkms_v1.projects.locations.keyRings.importJobs.html @@ -81,7 +81,7 @@Instance Methods
create(parent, body=None, importJobId=None, x__xgafv=None)Create a new ImportJob within a KeyRing. ImportJob.import_method is required.
+get(name, publicKeyFormat=None, x__xgafv=None)Returns metadata for a given ImportJob.
@@ -138,8 +138,10 @@
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)Method Details
"name": "A String", # Output only. The resource name for this ImportJob in the format `projects/*/locations/*/keyRings/*/importJobs/*`. "protectionLevel": "A String", # Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into. "publicKey": { # The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod. # Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE. - "pem": "A String", # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). + "data": "A String", # Output only. Contains the public key, formatted according to the PublicKey.PublicKeyFormat specified in the KeyManagementService.GetImportJob request. + "pem": "A String", # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). This field gets populated by default for RSA-based import methods, if no public_key_format is specified in the request. If you want to retrieve the wrapping key of an ImportJob in some other format, use KeyManagementService.GetImportJob and set the public_key_format to the desired public key format. }, + "publicKeyFormat": "A String", # Output only. Specifies the WrappingPublicKey format provided by the customer in the KeyManagementService.GetImportJob request. "state": "A String", # Output only. The current state of the ImportJob, indicating if it can be used. } @@ -177,18 +179,27 @@Method Details
"name": "A String", # Output only. The resource name for this ImportJob in the format `projects/*/locations/*/keyRings/*/importJobs/*`. "protectionLevel": "A String", # Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into. "publicKey": { # The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod. # Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE. - "pem": "A String", # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). + "data": "A String", # Output only. Contains the public key, formatted according to the PublicKey.PublicKeyFormat specified in the KeyManagementService.GetImportJob request. + "pem": "A String", # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). This field gets populated by default for RSA-based import methods, if no public_key_format is specified in the request. If you want to retrieve the wrapping key of an ImportJob in some other format, use KeyManagementService.GetImportJob and set the public_key_format to the desired public key format. }, + "publicKeyFormat": "A String", # Output only. Specifies the WrappingPublicKey format provided by the customer in the KeyManagementService.GetImportJob request. "state": "A String", # Output only. The current state of the ImportJob, indicating if it can be used. }-@@ -321,8 +334,10 @@get(name, x__xgafv=None)+get(name, publicKeyFormat=None, x__xgafv=None)Returns metadata for a given ImportJob. Args: name: string, Required. The name of the ImportJob to get. (required) + publicKeyFormat: string, Optional. Specifies the WrappingPublicKey format. If not specified: * For RSA-based import methods, the wrapping key will be returned in PEM format * For pure ML-KEM-based import methods, the wrapping key will be returned in the raw bytes format specified in FIPS-203 * For X-Wing-based import methods, the wrapping key will be returned in the raw bytes format specified in https://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem. + Allowed values + PUBLIC_KEY_FORMAT_UNSPECIFIED - If the public_key_format field is not specified: - For PQC algorithms, an error will be returned. - For non-PQC algorithms, the default format is PEM, and the field pem will be populated. Otherwise, the public key will be exported through the public_key field in the requested format. + PEM - The returned public key will be encoded in PEM format. See the [RFC7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13) for more information. + DER - The returned public key will be encoded in DER format (the PrivateKeyInfo structure from RFC 5208). + NIST_PQC - This is supported only for PQC algorithms. The key material is returned in the format defined by NIST PQC standards (FIPS 203, FIPS 204, and FIPS 205). + XWING_RAW_BYTES - The returned public key is in raw bytes format defined in its standard https://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -222,8 +233,10 @@Method Details
"name": "A String", # Output only. The resource name for this ImportJob in the format `projects/*/locations/*/keyRings/*/importJobs/*`. "protectionLevel": "A String", # Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into. "publicKey": { # The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod. # Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE. - "pem": "A String", # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). + "data": "A String", # Output only. Contains the public key, formatted according to the PublicKey.PublicKeyFormat specified in the KeyManagementService.GetImportJob request. + "pem": "A String", # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). This field gets populated by default for RSA-based import methods, if no public_key_format is specified in the request. If you want to retrieve the wrapping key of an ImportJob in some other format, use KeyManagementService.GetImportJob and set the public_key_format to the desired public key format. }, + "publicKeyFormat": "A String", # Output only. Specifies the WrappingPublicKey format provided by the customer in the KeyManagementService.GetImportJob request. "state": "A String", # Output only. The current state of the ImportJob, indicating if it can be used. }Method Details
"name": "A String", # Output only. The resource name for this ImportJob in the format `projects/*/locations/*/keyRings/*/importJobs/*`. "protectionLevel": "A String", # Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into. "publicKey": { # The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod. # Output only. The public key with which to wrap key material prior to import. Only returned if state is ACTIVE. - "pem": "A String", # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). + "data": "A String", # Output only. Contains the public key, formatted according to the PublicKey.PublicKeyFormat specified in the KeyManagementService.GetImportJob request. + "pem": "A String", # The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). This field gets populated by default for RSA-based import methods, if no public_key_format is specified in the request. If you want to retrieve the wrapping key of an ImportJob in some other format, use KeyManagementService.GetImportJob and set the public_key_format to the desired public key format. }, + "publicKeyFormat": "A String", # Output only. Specifies the WrappingPublicKey format provided by the customer in the KeyManagementService.GetImportJob request. "state": "A String", # Output only. The current state of the ImportJob, indicating if it can be used. }, ], diff --git a/docs/dyn/cloudsupport_v2.cases.attachments.html b/docs/dyn/cloudsupport_v2.cases.attachments.html index 3bfad47568..d73f6f2ec2 100644 --- a/docs/dyn/cloudsupport_v2.cases.attachments.html +++ b/docs/dyn/cloudsupport_v2.cases.attachments.html @@ -77,6 +77,9 @@Instance Methods
Close httplib2 connections.
+ +Retrieve an attachment associated with a support case. EXAMPLES: cURL: ```shell attachment="projects/some-project/cases/23598314/attachments/0684M00000P3h1fQAB" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$attachment" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .get(name="projects/some-project/cases/43595344/attachments/0684M00000P3h1fQAB") ) print(request.execute()) ```
list(parent, pageSize=None, pageToken=None, x__xgafv=None)List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/23598314" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
@@ -89,6 +92,35 @@Method Details
Close httplib2 connections.
get(name, x__xgafv=None)
+ Retrieve an attachment associated with a support case. EXAMPLES: cURL: ```shell attachment="projects/some-project/cases/23598314/attachments/0684M00000P3h1fQAB" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$attachment" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .get(name="projects/some-project/cases/43595344/attachments/0684M00000P3h1fQAB") ) print(request.execute()) ```
+
+Args:
+ name: string, Required. The name of the attachment to get. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Attachment contains metadata about a file that was uploaded to a case - it is NOT a file itself. That being said, the name of an Attachment object can be used to download its accompanying file through the `media.download` endpoint. While attachments can be uploaded in the console at the same time as a comment, they're associated on a "case" level, not a "comment" level.
+ "createTime": "A String", # Output only. The time at which the attachment was created.
+ "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user who uploaded the attachment. Note, the name and email will be obfuscated if the attachment was uploaded by Google support.
+ "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.
+ "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead.
+ "googleSupport": True or False, # Output only. Whether the actor is a Google support actor.
+ "username": "A String", # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set.
+ },
+ "filename": "A String", # The filename of the attachment (e.g. `"graph.jpg"`).
+ "mimeType": "A String", # Output only. The MIME type of the attachment (e.g. text/plain).
+ "name": "A String", # Output only. Identifier. The resource name of the attachment.
+ "sizeBytes": "A String", # Output only. The size of the attachment in bytes.
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/23598314" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
diff --git a/docs/dyn/cloudsupport_v2.cases.comments.html b/docs/dyn/cloudsupport_v2.cases.comments.html
index 5d5ff70b9d..776bf57deb 100644
--- a/docs/dyn/cloudsupport_v2.cases.comments.html
+++ b/docs/dyn/cloudsupport_v2.cases.comments.html
@@ -80,6 +80,9 @@ Instance Methods
create(parent, body=None, x__xgafv=None)
Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43591344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "body": "This is a test comment." }' \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .create( parent="projects/some-project/cases/43595344", body={"body": "This is a test comment."}, ) ) print(request.execute()) ```
+
+Retrieve a comment. EXAMPLES: cURL: ```shell comment="projects/some-project/cases/43595344/comments/234567890" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$comment" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().comments().get( name="projects/some-project/cases/43595344/comments/234567890", ) print(request.execute()) ```
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
List all the comments associated with a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
@@ -136,6 +139,34 @@ Method Details
}
get(name, x__xgafv=None)
+ Retrieve a comment. EXAMPLES: cURL: ```shell comment="projects/some-project/cases/43595344/comments/234567890" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$comment" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().comments().get( name="projects/some-project/cases/43595344/comments/234567890", ) print(request.execute()) ```
+
+Args:
+ name: string, Required. The name of the comment to retrieve. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A comment associated with a support case. Case comments are the primary way for Google Support to communicate with a user who has opened a case. When a user responds to Google Support, the user's responses also appear as comments.
+ "body": "A String", # The full comment body. Maximum of 12800 characters.
+ "createTime": "A String", # Output only. The time when the comment was created.
+ "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # Output only. The user or Google Support agent who created the comment.
+ "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent.
+ "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead.
+ "googleSupport": True or False, # Output only. Whether the actor is a Google support actor.
+ "username": "A String", # Output only. The username of the actor. It may look like an email or other format provided by the identity provider. If not provided, it is inferred from the credentials supplied. When a name is provided, a username must also be provided. If the user is a Google Support agent, this will not be set.
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the comment.
+ "plainTextBody": "A String", # Output only. DEPRECATED. DO NOT USE. A duplicate of the `body` field. This field is only present for legacy reasons.
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
List all the comments associated with a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
diff --git a/docs/dyn/cloudsupport_v2.media.html b/docs/dyn/cloudsupport_v2.media.html
index 89b422bf83..67f7447c46 100644
--- a/docs/dyn/cloudsupport_v2.media.html
+++ b/docs/dyn/cloudsupport_v2.media.html
@@ -85,7 +85,7 @@ Instance Methods
Download a file attached to a case. When this endpoint is called, no "response body" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```
upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)
-Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```
+Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```
Method Details
close()
@@ -346,6 +346,7 @@ Method Details
"referenceType": "A String", # # gdata.* are outside protos with mising documentation
"sha1Hash": "A String", # # gdata.* are outside protos with mising documentation
"sha256Hash": "A String", # # gdata.* are outside protos with mising documentation
+ "sha512Hash": "A String", # # gdata.* are outside protos with mising documentation
"timestamp": "A String", # # gdata.* are outside protos with mising documentation
"token": "A String", # # gdata.* are outside protos with mising documentation
}
@@ -370,7 +371,7 @@ Method Details
upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)
- Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```
+ Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```
Args:
parent: string, Required. The name of the case or Cloud resource to which the attachment should be attached. (required)
diff --git a/docs/dyn/cloudsupport_v2beta.caseClassifications.html b/docs/dyn/cloudsupport_v2beta.caseClassifications.html
index 94a83a4556..8d9cd46da5 100644
--- a/docs/dyn/cloudsupport_v2beta.caseClassifications.html
+++ b/docs/dyn/cloudsupport_v2beta.caseClassifications.html
@@ -79,7 +79,7 @@ Instance Methods
Close httplib2 connections.
search(pageSize=None, pageToken=None, product_productLine=None, query=None, x__xgafv=None)
-Retrieve valid classifications to use when creating a support case. Classifications are hierarchical. Each classification is a string containing all levels of the hierarchy separated by `" > "`. For example, `"Technical Issue > Compute > Compute Engine"`. Classification IDs returned by this endpoint are valid for at least six months. When a classification is deactivated, this endpoint immediately stops returning it. After six months, `case.create` requests using the classification will fail. EXAMPLES: cURL: ```shell curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ 'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"' ``` Python: ```python import googleapiclient.discovery supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version="v2", discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2", ) request = supportApiService.caseClassifications().search( query='display_name:"*Compute Engine*"' ) print(request.execute()) ```
+Retrieve valid classifications to use when creating a support case. Classifications are hierarchical. Each classification is a string containing all levels of the hierarchy separated by `" > "`. For example, `"Technical Issue > Compute > Compute Engine"`. Classification IDs returned by this endpoint are valid for at least six months. When a classification is deactivated, this endpoint immediately stops returning it. After six months, `case.create` requests using the classification will fail. EXAMPLES: cURL: ```shell curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ 'https://cloudsupport.googleapis.com/v2beta/caseClassifications:search?query=display_name:"*Compute%20Engine*"' ``` Python: ```python import googleapiclient.discovery supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version="v2beta", discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2", ) request = supportApiService.caseClassifications().search( query='display_name:"*Compute Engine*"' ) print(request.execute()) ```
Retrieves the next page of results.
@@ -91,7 +91,7 @@ Method Details
search(pageSize=None, pageToken=None, product_productLine=None, query=None, x__xgafv=None)
- Retrieve valid classifications to use when creating a support case. Classifications are hierarchical. Each classification is a string containing all levels of the hierarchy separated by `" > "`. For example, `"Technical Issue > Compute > Compute Engine"`. Classification IDs returned by this endpoint are valid for at least six months. When a classification is deactivated, this endpoint immediately stops returning it. After six months, `case.create` requests using the classification will fail. EXAMPLES: cURL: ```shell curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ 'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"' ``` Python: ```python import googleapiclient.discovery supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version="v2", discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2", ) request = supportApiService.caseClassifications().search( query='display_name:"*Compute Engine*"' ) print(request.execute()) ```
+ Retrieve valid classifications to use when creating a support case. Classifications are hierarchical. Each classification is a string containing all levels of the hierarchy separated by `" > "`. For example, `"Technical Issue > Compute > Compute Engine"`. Classification IDs returned by this endpoint are valid for at least six months. When a classification is deactivated, this endpoint immediately stops returning it. After six months, `case.create` requests using the classification will fail. EXAMPLES: cURL: ```shell curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ 'https://cloudsupport.googleapis.com/v2beta/caseClassifications:search?query=display_name:"*Compute%20Engine*"' ``` Python: ```python import googleapiclient.discovery supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version="v2beta", discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2", ) request = supportApiService.caseClassifications().search( query='display_name:"*Compute Engine*"' ) print(request.execute()) ```
Args:
pageSize: integer, The maximum number of classifications fetched with each request.
diff --git a/docs/dyn/cloudsupport_v2beta.cases.attachments.html b/docs/dyn/cloudsupport_v2beta.cases.attachments.html
index 336e9f6b01..d7eb7ea96d 100644
--- a/docs/dyn/cloudsupport_v2beta.cases.attachments.html
+++ b/docs/dyn/cloudsupport_v2beta.cases.attachments.html
@@ -79,10 +79,10 @@ Instance Methods
Close httplib2 connections.
-Retrieve an attachment associated with a support case. EXAMPLES: cURL: ```shell attachment="projects/some-project/cases/23598314/attachments/0684M00000P3h1fQAB" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$attachment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .get(name="projects/some-project/cases/43595344/attachments/0684M00000P3h1fQAB") ) print(request.execute()) ```
+Retrieve an attachment associated with a support case. EXAMPLES: cURL: ```shell attachment="projects/some-project/cases/23598314/attachments/0684M00000P3h1fQAB" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$attachment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .get(name="projects/some-project/cases/43595344/attachments/0684M00000P3h1fQAB") ) print(request.execute()) ```
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
-List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/23598314" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
+List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/23598314" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$case/attachments" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
Retrieves the next page of results.
@@ -94,7 +94,7 @@ Method Details
get(name, x__xgafv=None)
- Retrieve an attachment associated with a support case. EXAMPLES: cURL: ```shell attachment="projects/some-project/cases/23598314/attachments/0684M00000P3h1fQAB" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$attachment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .get(name="projects/some-project/cases/43595344/attachments/0684M00000P3h1fQAB") ) print(request.execute()) ```
+ Retrieve an attachment associated with a support case. EXAMPLES: cURL: ```shell attachment="projects/some-project/cases/23598314/attachments/0684M00000P3h1fQAB" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$attachment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .get(name="projects/some-project/cases/43595344/attachments/0684M00000P3h1fQAB") ) print(request.execute()) ```
Args:
name: string, Required. The name of the attachment to get. (required)
@@ -123,7 +123,7 @@ Method Details
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
- List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/23598314" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/attachments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
+ List all the attachments associated with a support case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/23598314" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$case/attachments" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .attachments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
Args:
parent: string, Required. The name of the case for which attachments should be listed. (required)
diff --git a/docs/dyn/cloudsupport_v2beta.cases.comments.html b/docs/dyn/cloudsupport_v2beta.cases.comments.html
index 69eb6b78a0..71ee5135e6 100644
--- a/docs/dyn/cloudsupport_v2beta.cases.comments.html
+++ b/docs/dyn/cloudsupport_v2beta.cases.comments.html
@@ -79,13 +79,13 @@ Instance Methods
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
-Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43591344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "body": "This is a test comment." }' \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .create( parent="projects/some-project/cases/43595344", body={"body": "This is a test comment."}, ) ) print(request.execute()) ```
+Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43591344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "body": "This is a test comment." }' \ "https://cloudsupport.googleapis.com/v2beta/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .create( parent="projects/some-project/cases/43595344", body={"body": "This is a test comment."}, ) ) print(request.execute()) ```
-Retrieve a comment. EXAMPLES: cURL: ```shell comment="projects/some-project/cases/43595344/comments/234567890" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$comment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().comments().get( name="projects/some-project/cases/43595344/comments/234567890", ) print(request.execute()) ```
+Retrieve a comment. EXAMPLES: cURL: ```shell comment="projects/some-project/cases/43595344/comments/234567890" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$comment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().comments().get( name="projects/some-project/cases/43595344/comments/234567890", ) print(request.execute()) ```
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
-List all the comments associated with a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
+List all the comments associated with a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
Retrieves the next page of results.
@@ -97,7 +97,7 @@ Method Details
create(parent, body=None, x__xgafv=None)
- Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43591344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "body": "This is a test comment." }' \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .create( parent="projects/some-project/cases/43595344", body={"body": "This is a test comment."}, ) ) print(request.execute()) ```
+ Add a new comment to a case. The comment must have the following fields set: `body`. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43591344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "body": "This is a test comment." }' \ "https://cloudsupport.googleapis.com/v2beta/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .create( parent="projects/some-project/cases/43595344", body={"body": "This is a test comment."}, ) ) print(request.execute()) ```
Args:
parent: string, Required. The name of the case to which the comment should be added. (required)
@@ -141,7 +141,7 @@ Method Details
get(name, x__xgafv=None)
- Retrieve a comment. EXAMPLES: cURL: ```shell comment="projects/some-project/cases/43595344/comments/234567890" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$comment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().comments().get( name="projects/some-project/cases/43595344/comments/234567890", ) print(request.execute()) ```
+ Retrieve a comment. EXAMPLES: cURL: ```shell comment="projects/some-project/cases/43595344/comments/234567890" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$comment" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().comments().get( name="projects/some-project/cases/43595344/comments/234567890", ) print(request.execute()) ```
Args:
name: string, Required. The name of the comment to retrieve. (required)
@@ -169,7 +169,7 @@ Method Details
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
- List all the comments associated with a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
+ List all the comments associated with a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$case/comments" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = ( supportApiService.cases() .comments() .list(parent="projects/some-project/cases/43595344") ) print(request.execute()) ```
Args:
parent: string, Required. The name of the case for which to list comments. (required)
diff --git a/docs/dyn/cloudsupport_v2beta.cases.html b/docs/dyn/cloudsupport_v2beta.cases.html
index 5e0b02c8f7..842c33d41c 100644
--- a/docs/dyn/cloudsupport_v2beta.cases.html
+++ b/docs/dyn/cloudsupport_v2beta.cases.html
@@ -86,28 +86,28 @@ Instance Methods
close(name, body=None, x__xgafv=None)
-Close a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case:close" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().close( name="projects/some-project/cases/43595344" ) print(request.execute()) ```
+Close a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$case:close" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().close( name="projects/some-project/cases/43595344" ) print(request.execute()) ```
create(parent, body=None, x__xgafv=None)
-Create a new case and associate it with a parent. It must have the following fields set: `display_name`, `description`, `classification`, and `priority`. If you're just testing the API and don't want to route your case to an agent, set `testCase=true`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "display_name": "Test case created by me.", "description": "a random test case, feel free to close", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, "time_zone": "-07:00", "subscriber_email_addresses": [ "foo@domain.com", "bar@domain.com" ], "testCase": true, "priority": "P3" }' \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().create( parent="projects/some-project", body={ "displayName": "A Test Case", "description": "This is a test case.", "testCase": True, "priority": "P2", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, }, ) print(request.execute()) ```
+Create a new case and associate it with a parent. It must have the following fields set: `display_name`, `description`, `classification`, and `priority`. If you're just testing the API and don't want to route your case to an agent, set `testCase=true`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "display_name": "Test case created by me.", "description": "a random test case, feel free to close", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, "time_zone": "-07:00", "subscriber_email_addresses": [ "foo@domain.com", "bar@domain.com" ], "testCase": true, "priority": "P3" }' \ "https://cloudsupport.googleapis.com/v2beta/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().create( parent="projects/some-project", body={ "displayName": "A Test Case", "description": "This is a test case.", "testCase": True, "priority": "P2", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, }, ) print(request.execute()) ```
escalate(name, body=None, x__xgafv=None)
-Escalate a case, starting the Google Cloud Support escalation management process. This operation is only available for some support services. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which ones let you do that. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation." } }' \ "https://cloudsupport.googleapis.com/v2/$case:escalate" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().escalate( name="projects/some-project/cases/43595344", body={ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation.", }, }, ) print(request.execute()) ```
+Escalate a case, starting the Google Cloud Support escalation management process. This operation is only available for some support services. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which ones let you do that. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation." } }' \ "https://cloudsupport.googleapis.com/v2beta/$case:escalate" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().escalate( name="projects/some-project/cases/43595344", body={ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation.", }, }, ) print(request.execute()) ```
-Retrieve a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/16033687" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().get( name="projects/some-project/cases/43595344", ) print(request.execute()) ```
+Retrieve a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/16033687" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$case" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().get( name="projects/some-project/cases/43595344", ) print(request.execute()) ```
list(parent, filter=None, pageSize=None, pageToken=None, productLine=None, x__xgafv=None)
-Retrieve all cases under a parent, but not its children. For example, listing cases under an organization only returns the cases that are directly parented by that organization. To retrieve cases under an organization and its projects, use `cases.search`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().list(parent="projects/some-project") print(request.execute()) ```
+Retrieve all cases under a parent, but not its children. For example, listing cases under an organization only returns the cases that are directly parented by that organization. To retrieve cases under an organization and its projects, use `cases.search`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().list(parent="projects/some-project") print(request.execute()) ```
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
-Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "priority": "P1" }' \ "https://cloudsupport.googleapis.com/v2/$case?updateMask=priority" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().patch( name="projects/some-project/cases/43112854", body={ "displayName": "This is Now a New Title", "priority": "P2", }, ) print(request.execute()) ```
+Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "priority": "P1" }' \ "https://cloudsupport.googleapis.com/v2beta/$case?updateMask=priority" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().patch( name="projects/some-project/cases/43112854", body={ "displayName": "This is Now a New Title", "priority": "P2", }, ) print(request.execute()) ```
search(pageSize=None, pageToken=None, parent=None, query=None, x__xgafv=None)
-Search for cases using a query. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/cases:search" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().search( parent="projects/some-project", query="state=OPEN" ) print(request.execute()) ```
+Search for cases using a query. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$parent/cases:search" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().search( parent="projects/some-project", query="state=OPEN" ) print(request.execute()) ```
Retrieves the next page of results.
@@ -120,7 +120,7 @@ Instance Methods
Method Details
close(name, body=None, x__xgafv=None)
- Close a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case:close" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().close( name="projects/some-project/cases/43595344" ) print(request.execute()) ```
+ Close a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$case:close" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().close( name="projects/some-project/cases/43595344" ) print(request.execute()) ```
Args:
name: string, Required. The name of the case to close. (required)
@@ -173,7 +173,7 @@ Method Details
create(parent, body=None, x__xgafv=None)
- Create a new case and associate it with a parent. It must have the following fields set: `display_name`, `description`, `classification`, and `priority`. If you're just testing the API and don't want to route your case to an agent, set `testCase=true`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "display_name": "Test case created by me.", "description": "a random test case, feel free to close", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, "time_zone": "-07:00", "subscriber_email_addresses": [ "foo@domain.com", "bar@domain.com" ], "testCase": true, "priority": "P3" }' \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().create( parent="projects/some-project", body={ "displayName": "A Test Case", "description": "This is a test case.", "testCase": True, "priority": "P2", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, }, ) print(request.execute()) ```
+ Create a new case and associate it with a parent. It must have the following fields set: `display_name`, `description`, `classification`, and `priority`. If you're just testing the API and don't want to route your case to an agent, set `testCase=true`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "display_name": "Test case created by me.", "description": "a random test case, feel free to close", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, "time_zone": "-07:00", "subscriber_email_addresses": [ "foo@domain.com", "bar@domain.com" ], "testCase": true, "priority": "P3" }' \ "https://cloudsupport.googleapis.com/v2beta/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().create( parent="projects/some-project", body={ "displayName": "A Test Case", "description": "This is a test case.", "testCase": True, "priority": "P2", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, }, ) print(request.execute()) ```
Args:
parent: string, Required. The name of the parent under which the case should be created. (required)
@@ -255,7 +255,7 @@ Method Details
escalate(name, body=None, x__xgafv=None)
- Escalate a case, starting the Google Cloud Support escalation management process. This operation is only available for some support services. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which ones let you do that. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation." } }' \ "https://cloudsupport.googleapis.com/v2/$case:escalate" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().escalate( name="projects/some-project/cases/43595344", body={ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation.", }, }, ) print(request.execute()) ```
+ Escalate a case, starting the Google Cloud Support escalation management process. This operation is only available for some support services. Go to https://cloud.google.com/support and look for 'Technical support escalations' in the feature list to find out which ones let you do that. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation." } }' \ "https://cloudsupport.googleapis.com/v2beta/$case:escalate" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().escalate( name="projects/some-project/cases/43595344", body={ "escalation": { "reason": "BUSINESS_IMPACT", "justification": "This is a test escalation.", }, }, ) print(request.execute()) ```
Args:
name: string, Required. The name of the case to be escalated. (required)
@@ -312,7 +312,7 @@ Method Details
get(name, x__xgafv=None)
- Retrieve a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/16033687" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().get( name="projects/some-project/cases/43595344", ) print(request.execute()) ```
+ Retrieve a case. EXAMPLES: cURL: ```shell case="projects/some-project/cases/16033687" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$case" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().get( name="projects/some-project/cases/43595344", ) print(request.execute()) ```
Args:
name: string, Required. The full name of a case to be retrieved. (required)
@@ -359,7 +359,7 @@ Method Details
list(parent, filter=None, pageSize=None, pageToken=None, productLine=None, x__xgafv=None)
- Retrieve all cases under a parent, but not its children. For example, listing cases under an organization only returns the cases that are directly parented by that organization. To retrieve cases under an organization and its projects, use `cases.search`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().list(parent="projects/some-project") print(request.execute()) ```
+ Retrieve all cases under a parent, but not its children. For example, listing cases under an organization only returns the cases that are directly parented by that organization. To retrieve cases under an organization and its projects, use `cases.search`. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$parent/cases" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().list(parent="projects/some-project") print(request.execute()) ```
Args:
parent: string, Required. The name of a parent to list cases under. (required)
@@ -433,7 +433,7 @@ Method Details
patch(name, body=None, updateMask=None, x__xgafv=None)
- Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "priority": "P1" }' \ "https://cloudsupport.googleapis.com/v2/$case?updateMask=priority" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().patch( name="projects/some-project/cases/43112854", body={ "displayName": "This is Now a New Title", "priority": "P2", }, ) print(request.execute()) ```
+ Update a case. Only some fields can be updated. EXAMPLES: cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "priority": "P1" }' \ "https://cloudsupport.googleapis.com/v2beta/$case?updateMask=priority" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().patch( name="projects/some-project/cases/43112854", body={ "displayName": "This is Now a New Title", "priority": "P2", }, ) print(request.execute()) ```
Args:
name: string, Identifier. The resource name for the case. (required)
@@ -516,7 +516,7 @@ Method Details
search(pageSize=None, pageToken=None, parent=None, query=None, x__xgafv=None)
- Search for cases using a query. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/cases:search" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().search( parent="projects/some-project", query="state=OPEN" ) print(request.execute()) ```
+ Search for cases using a query. EXAMPLES: cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$parent/cases:search" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().search( parent="projects/some-project", query="state=OPEN" ) print(request.execute()) ```
Args:
pageSize: integer, The maximum number of cases fetched with each request. The default page size is 10.
diff --git a/docs/dyn/cloudsupport_v2beta.media.html b/docs/dyn/cloudsupport_v2beta.media.html
index f6f9d11636..49dcacf3e9 100644
--- a/docs/dyn/cloudsupport_v2beta.media.html
+++ b/docs/dyn/cloudsupport_v2beta.media.html
@@ -79,13 +79,13 @@ Instance Methods
Close httplib2 connections.
-Download a file attached to a case. When this endpoint is called, no "response body" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```
+Download a file attached to a case. When this endpoint is called, no "response body" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```
download_media(name, x__xgafv=None)
-Download a file attached to a case. When this endpoint is called, no "response body" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```
+Download a file attached to a case. When this endpoint is called, no "response body" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```
upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)
-Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```
+Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```
Method Details
close()
@@ -94,7 +94,7 @@ Method Details
download(name, x__xgafv=None)
- Download a file attached to a case. When this endpoint is called, no "response body" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```
+ Download a file attached to a case. When this endpoint is called, no "response body" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```
Args:
name: string, The name of the file attachment to download. (required)
@@ -346,6 +346,7 @@ Method Details
"referenceType": "A String", # # gdata.* are outside protos with mising documentation
"sha1Hash": "A String", # # gdata.* are outside protos with mising documentation
"sha256Hash": "A String", # # gdata.* are outside protos with mising documentation
+ "sha512Hash": "A String", # # gdata.* are outside protos with mising documentation
"timestamp": "A String", # # gdata.* are outside protos with mising documentation
"token": "A String", # # gdata.* are outside protos with mising documentation
}
@@ -353,7 +354,7 @@ Method Details
download_media(name, x__xgafv=None)
- Download a file attached to a case. When this endpoint is called, no "response body" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```
+ Download a file attached to a case. When this endpoint is called, no "response body" will be returned. Instead, the attachment's blob will be returned. Note: HTTP requests must append "?alt=media" to the URL. EXAMPLES: cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$name:download?alt=media" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.media().download( name="projects/some-project/cases/43595344/attachments/0684M00000Pw6pHQAR" ) request.uri = request.uri.split("?")[0] + "?alt=media" print(request.execute()) ```
Args:
name: string, The name of the file attachment to download. (required)
@@ -370,7 +371,7 @@ Method Details
upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)
- Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```
+ Create a file attachment on a case or Cloud resource. The attachment must have the following fields set: `filename`. EXAMPLES: cURL: ```shell echo "This text is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) file_path = "./example_file.txt" with open(file_path, "w") as file: file.write( "This text is inside a file I'm going to upload using the Cloud Support API.", ) request = supportApiService.media().upload( parent="projects/some-project/cases/43595344", media_body=file_path ) request.uri = request.uri.split("?")[0] + "?attachment.filename=uploaded_via_python.txt" print(request.execute()) ```
Args:
parent: string, Required. The name of the case or Cloud resource to which the attachment should be attached. (required)
diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.html
index 119943597c..fef581ed25 100644
--- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.html
+++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.html
@@ -136,6 +136,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -174,6 +175,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -205,6 +207,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -268,6 +271,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -306,6 +310,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -349,6 +354,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -410,6 +416,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html
index 0e138ffeff..0b0d7f0c6e 100644
--- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html
+++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html
@@ -500,6 +500,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -1033,6 +1034,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html b/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html
index b23d81b549..bcb63cfb0f 100644
--- a/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html
+++ b/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html
@@ -615,6 +615,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.assessments.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.assessments.html
index 656a75046e..962c05a7e2 100644
--- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.assessments.html
+++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.assessments.html
@@ -136,6 +136,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -174,6 +175,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -205,6 +207,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -268,6 +271,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -306,6 +310,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -349,6 +354,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -410,6 +416,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html
index a85c061334..23589ed188 100644
--- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html
+++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html
@@ -594,6 +594,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -1110,6 +1111,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -1684,6 +1686,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -2286,6 +2289,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -2820,6 +2824,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -3338,6 +3343,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -3913,6 +3919,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html
index dcbef8ef2b..ed88c4c1e3 100644
--- a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html
+++ b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html
@@ -555,6 +555,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
@@ -1157,6 +1158,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.diagnostics.html b/docs/dyn/contactcenterinsights_v1.projects.locations.diagnostics.html
index 5601d9aae4..7d1054c943 100644
--- a/docs/dyn/contactcenterinsights_v1.projects.locations.diagnostics.html
+++ b/docs/dyn/contactcenterinsights_v1.projects.locations.diagnostics.html
@@ -84,7 +84,7 @@ Instance Methods
get(name, x__xgafv=None)
Gets a diagnostic.
- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ list(parent, appId=None, appVersion=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists diagnostics.
@@ -128,11 +128,16 @@ Method Details
An object of the form:
{ # The diagnostic resource.
+ "agentDisplayName": "A String", # Output only. The display name of the agent associated with the diagnostic.
+ "agentId": "A String", # Output only. The ID of the agent associated with the diagnostic.
"analysisSummary": "A String", # Output only. The complete sequence of thoughts and actions taken by the agent.
+ "appId": "A String", # Output only. The application ID associated with the diagnostic.
+ "appVersion": "A String", # Output only. The application version associated with the diagnostic.
"conversationFilter": "A String", # Output only. The filter used to select the conversations that were included in the diagnostic.
"createTime": "A String", # Output only. The time at which the diagnostic was created.
+ "groupCreateTime": "A String", # Output only. The timestamp when the group was created.
"name": "A String", # Immutable. Identifier. The resource name of the diagnostic.
- "report": { # A diagnostic report containing aggregate metrics and intent breakdowns. # Output only. The report containing the findings of the diagnostic.
+ "report": { # A diagnostic report containing loss patterns and problematic slice stats. # Output only. The report containing the findings of the diagnostic.
"conversationSlices": { # Output only. A map of conversation slices used in the report.
"a_key": { # Output only. A map of conversation slices used in the report.
"conversationIds": [ # The list of conversation IDs that match this slice.
@@ -237,11 +242,13 @@ Method Details
- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ list(parent, appId=None, appVersion=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists diagnostics.
Args:
parent: string, Required. The parent resource of the diagnostics. (required)
+ appId: string, Optional. The CES App ID to filter diagnostics by.
+ appVersion: string, Optional. The CES App version to filter diagnostics by.
filter: string, Optional. A filter to apply to the list (e.g. `create_time > "2023-01-01T00:00:00Z"`).
pageSize: integer, Optional. The maximum number of diagnostics to return. The service may return fewer than this value. If unspecified, at most 100 diagnostics will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `ListDiagnostics` call. Provide this to retrieve the subsequent page.
@@ -256,11 +263,16 @@ Method Details
{ # The response from a ListDiagnostics request.
"diagnostics": [ # Optional. The diagnostics that match the request.
{ # The diagnostic resource.
+ "agentDisplayName": "A String", # Output only. The display name of the agent associated with the diagnostic.
+ "agentId": "A String", # Output only. The ID of the agent associated with the diagnostic.
"analysisSummary": "A String", # Output only. The complete sequence of thoughts and actions taken by the agent.
+ "appId": "A String", # Output only. The application ID associated with the diagnostic.
+ "appVersion": "A String", # Output only. The application version associated with the diagnostic.
"conversationFilter": "A String", # Output only. The filter used to select the conversations that were included in the diagnostic.
"createTime": "A String", # Output only. The time at which the diagnostic was created.
+ "groupCreateTime": "A String", # Output only. The timestamp when the group was created.
"name": "A String", # Immutable. Identifier. The resource name of the diagnostic.
- "report": { # A diagnostic report containing aggregate metrics and intent breakdowns. # Output only. The report containing the findings of the diagnostic.
+ "report": { # A diagnostic report containing loss patterns and problematic slice stats. # Output only. The report containing the findings of the diagnostic.
"conversationSlices": { # Output only. A map of conversation slices used in the report.
"a_key": { # Output only. A map of conversation slices used in the report.
"conversationIds": [ # The list of conversation IDs that match this slice.
diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.html
index 85361d5482..d90ec470d5 100644
--- a/docs/dyn/contactcenterinsights_v1.projects.locations.html
+++ b/docs/dyn/contactcenterinsights_v1.projects.locations.html
@@ -370,10 +370,15 @@ Method Details
The object takes the form of:
{ # The request to analyze conversation data using agentic workflows. This RPC triggers a complex analysis process that may involve several steps of reasoning and tool execution.
+ "agentDisplayName": "A String", # ces agent display name (e.g., "Steering", "Billing").
+ "agentId": "A String", # ces agent id to diagnose.
+ "appId": "A String", # Required. The CES App ID.
+ "appVersion": "A String", # Optional. Optional but highly recommended. ces app version. If provided, specific version of agent instruction will be retrieved. If empty or set to '-', will use the latest draft version of instruction.
"dryRun": True or False, # Optional. Deprecated: If true, the request will be validated and a simulation of the analysis will be performed without actually executing the task. This field is unused. Use validate_only instead.
"filter": "A String", # Optional. AIP-160 compliant filter for selecting target conversations.
"fullReport": True or False, # Optional. Deprecated: If true, the agent will generate a full diagnostic report for all sub-agents. Subagent reporting configuration is unused. The final diagnostic details are already persisted inside the Diagnostic resource instead.
- "instructions": "A String", # Optional. Specific instructions for the agent.
+ "groupId": "A String", # Optional. A unique identifier used to group multiple diagnostic requests triggered under the same run batch or cron job.
+ "instructions": "A String", # Optional. Deprecated: Specific instructions for the agent. Use app_id and subagent fields instead.
"maxSteps": 42, # Optional. The maximum number of steps the agent can take during the execution of the task. Defaults to 10.
"metricType": "A String", # Optional. The type of metric being diagnosed.
"outputConfig": { # Configuration for where to export or return the analysis findings. # Optional. Deprecated: The configuration for the output of the task. The export destination is unused. Detailed markdown and conversation slices are already persisted inside the Diagnostic resource instead.
@@ -1101,6 +1106,7 @@ Method Details
"displayName": "A String", # The agent's name.
"dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
"entrySubagentDisplayName": "A String", # The entry subagent's display name.
+ "entrySubagentId": "A String", # The entry subagent's ID.
"location": "A String", # The agent's location.
"team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
"teams": [ # User-specified strings representing the agent's teams.
diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html
index 796aed6d43..a4f72537a8 100644
--- a/docs/dyn/container_v1.projects.locations.clusters.html
+++ b/docs/dyn/container_v1.projects.locations.clusters.html
@@ -1045,6 +1045,9 @@ Method Details
"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
},
},
+ "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode.
+ "nodeCreationMode": "A String", # The mode of node creation.
+ },
"nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
"nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes.
@@ -1615,6 +1618,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
@@ -1662,6 +1672,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -2782,6 +2794,9 @@ Method Details
"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
},
},
+ "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode.
+ "nodeCreationMode": "A String", # The mode of node creation.
+ },
"nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
"nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes.
@@ -3352,6 +3367,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
@@ -3399,6 +3421,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -4383,6 +4407,9 @@ Method Details
"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
},
},
+ "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode.
+ "nodeCreationMode": "A String", # The mode of node creation.
+ },
"nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
"nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes.
@@ -4953,6 +4980,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
@@ -5000,6 +5034,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -6484,6 +6520,9 @@ Method Details
"desiredNetworkTierConfig": { # NetworkTierConfig contains network tier information. # The desired network tier configuration for the cluster.
"networkTier": "A String", # Network tier configuration.
},
+ "desiredNodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. The desired NodeCreationConfig for the cluster.
+ "nodeCreationMode": "A String", # The mode of node creation.
+ },
"desiredNodeKubeletConfig": { # Node kubelet configs. # The desired node kubelet config for the cluster.
"allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
"A String",
diff --git a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html
index 173bc7f6d0..e35a260753 100644
--- a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html
+++ b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html
@@ -484,6 +484,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
@@ -531,6 +538,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -1103,6 +1112,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
@@ -1150,6 +1166,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -1549,6 +1567,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
@@ -1596,6 +1621,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -2199,6 +2226,8 @@ Method Details
"maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
"name": "A String", # The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # The desired node drain configuration for nodes in the node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config.
diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html
index 43bacbbfab..fa49873e4e 100644
--- a/docs/dyn/container_v1.projects.zones.clusters.html
+++ b/docs/dyn/container_v1.projects.zones.clusters.html
@@ -1156,6 +1156,9 @@ Method Details
"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
},
},
+ "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode.
+ "nodeCreationMode": "A String", # The mode of node creation.
+ },
"nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
"nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes.
@@ -1726,6 +1729,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
@@ -1773,6 +1783,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -2893,6 +2905,9 @@ Method Details
"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
},
},
+ "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode.
+ "nodeCreationMode": "A String", # The mode of node creation.
+ },
"nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
"nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes.
@@ -3463,6 +3478,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
@@ -3510,6 +3532,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -4538,6 +4562,9 @@ Method Details
"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
},
},
+ "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode.
+ "nodeCreationMode": "A String", # The mode of node creation.
+ },
"nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
"nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes.
@@ -5108,6 +5135,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
@@ -5155,6 +5189,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -6511,6 +6547,9 @@ Method Details
"desiredNetworkTierConfig": { # NetworkTierConfig contains network tier information. # The desired network tier configuration for the cluster.
"networkTier": "A String", # Network tier configuration.
},
+ "desiredNodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. The desired NodeCreationConfig for the cluster.
+ "nodeCreationMode": "A String", # The mode of node creation.
+ },
"desiredNodeKubeletConfig": { # Node kubelet configs. # The desired node kubelet config for the cluster.
"allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
"A String",
diff --git a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html
index 0f3f6daeaf..737ba51bd8 100644
--- a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html
+++ b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html
@@ -549,6 +549,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
@@ -596,6 +603,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -1168,6 +1177,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
@@ -1215,6 +1231,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -1614,6 +1632,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
@@ -1661,6 +1686,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -2189,6 +2216,8 @@ Method Details
"maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
"name": "A String", # The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # The desired node drain configuration for nodes in the node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config.
diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html
index 79b82754e4..dc74f56942 100644
--- a/docs/dyn/container_v1beta1.projects.locations.clusters.html
+++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html
@@ -1166,6 +1166,9 @@ Method Details
"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
},
},
+ "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode.
+ "nodeCreationMode": "A String", # The mode of node creation.
+ },
"nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
"nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes.
@@ -1761,6 +1764,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
@@ -1809,6 +1819,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -3006,6 +3018,9 @@ Method Details
"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
},
},
+ "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode.
+ "nodeCreationMode": "A String", # The mode of node creation.
+ },
"nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
"nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes.
@@ -3601,6 +3616,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
@@ -3649,6 +3671,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -4703,6 +4727,9 @@ Method Details
"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
},
},
+ "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode.
+ "nodeCreationMode": "A String", # The mode of node creation.
+ },
"nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
"nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes.
@@ -5298,6 +5325,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
@@ -5346,6 +5380,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -6898,6 +6934,9 @@ Method Details
"desiredNetworkTierConfig": { # NetworkTierConfig contains network tier information. # The desired network tier configuration for the cluster.
"networkTier": "A String", # Network tier configuration.
},
+ "desiredNodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. The desired NodeCreationConfig for the cluster.
+ "nodeCreationMode": "A String", # The mode of node creation.
+ },
"desiredNodeKubeletConfig": { # Node kubelet configs. # The desired node kubelet config for the cluster.
"allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
"A String",
diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html
index 0c776b7bd8..b712849663 100644
--- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html
+++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html
@@ -498,6 +498,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
@@ -546,6 +553,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -1134,6 +1143,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
@@ -1182,6 +1198,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -1595,6 +1613,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
@@ -1643,6 +1668,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -2247,6 +2274,8 @@ Method Details
"maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
"name": "A String", # The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # The desired node drain configuration for nodes in the node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config.
diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html
index 97da4d5096..fb6c288eb4 100644
--- a/docs/dyn/container_v1beta1.projects.zones.clusters.html
+++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html
@@ -1287,6 +1287,9 @@ Method Details
"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
},
},
+ "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode.
+ "nodeCreationMode": "A String", # The mode of node creation.
+ },
"nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
"nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes.
@@ -1882,6 +1885,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
@@ -1930,6 +1940,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -3127,6 +3139,9 @@ Method Details
"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
},
},
+ "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode.
+ "nodeCreationMode": "A String", # The mode of node creation.
+ },
"nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
"nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes.
@@ -3722,6 +3737,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
@@ -3770,6 +3792,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -4868,6 +4892,9 @@ Method Details
"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
},
},
+ "nodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. Configuration for Node Creation Mode.
+ "nodeCreationMode": "A String", # The mode of node creation.
+ },
"nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
"nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes.
@@ -5463,6 +5490,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
@@ -5511,6 +5545,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -6925,6 +6961,9 @@ Method Details
"desiredNetworkTierConfig": { # NetworkTierConfig contains network tier information. # The desired network tier configuration for the cluster.
"networkTier": "A String", # Network tier configuration.
},
+ "desiredNodeCreationConfig": { # NodeCreationConfig defines the settings of node creation mode. # Optional. The desired NodeCreationConfig for the cluster.
+ "nodeCreationMode": "A String", # The mode of node creation.
+ },
"desiredNodeKubeletConfig": { # Node kubelet configs. # The desired node kubelet config for the cluster.
"allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
"A String",
diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html
index 64c6017989..7be181257b 100644
--- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html
+++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html
@@ -563,6 +563,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
@@ -611,6 +618,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -1199,6 +1208,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
@@ -1247,6 +1263,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -1660,6 +1678,13 @@ Method Details
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
+ "maintenancePolicy": { # Defines the maintenance policy for the node pool. # Optional. Specifies the maintenance policy for the node pool.
+ "exclusionUntilEndOfSupport": { # Defines the maintenance exclusion for the node pool. # Optional. The exclusion until end of support for the node pool.
+ "enabled": True or False, # Optional. Indicates whether the exclusion is enabled.
+ "endTime": "A String", # Output only. The end time of the maintenance exclusion. It is output only. It is the cluster control plane version's end of support time, or end of extended support time when the cluster is on extended support channel.
+ "startTime": "A String", # Output only. The start time of the maintenance exclusion. It is output only. It is the exclusion creation time.
+ },
+ },
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
@@ -1708,6 +1733,8 @@ Method Details
"subnetwork": "A String", # Optional. The subnetwork name/path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork can be either: - A user supplied subnetwork name during node pool creation (e.g., `my-subnet`). The name must be between 1 and 63 characters long, start with a letter, contain only letters, numbers, and hyphens, and end with a letter or a number. - A full subnetwork path during node pool creation, such as `projects/gke-project/regions/us-central1/subnetworks/my-subnet` - A subnetwork path picked based on the IP utilization during node pool creation and is immutable.
},
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # Specifies the node drain configuration for this node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -2237,6 +2264,8 @@ Method Details
"maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
"name": "A String", # The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
"nodeDrainConfig": { # NodeDrainConfig contains the node drain related configurations for this node pool. # The desired node drain configuration for nodes in the node pool.
+ "graceTerminationDuration": "A String", # The duration of the grace termination period for node drain.
+ "pdbTimeoutDuration": "A String", # The duration of the PDB timeout period for node drain.
"respectPdbDuringNodePoolDeletion": True or False, # Whether to respect PDB during node pool deletion.
},
"nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config.
diff --git a/docs/dyn/dataform_v1.projects.locations.folders.html b/docs/dyn/dataform_v1.projects.locations.folders.html
index fde514afb3..3fb464aae5 100644
--- a/docs/dyn/dataform_v1.projects.locations.folders.html
+++ b/docs/dyn/dataform_v1.projects.locations.folders.html
@@ -400,7 +400,8 @@ Method Details
"displayName": "A String", # Optional. The repository's user-friendly name.
"gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
"authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
- "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.
+ "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used.
+ "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
"sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
"hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
"userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
diff --git a/docs/dyn/dataform_v1.projects.locations.html b/docs/dyn/dataform_v1.projects.locations.html
index cf87052997..614f434c17 100644
--- a/docs/dyn/dataform_v1.projects.locations.html
+++ b/docs/dyn/dataform_v1.projects.locations.html
@@ -262,7 +262,8 @@ Method Details
"displayName": "A String", # Optional. The repository's user-friendly name.
"gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
"authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
- "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.
+ "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used.
+ "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
"sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
"hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
"userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
diff --git a/docs/dyn/dataform_v1.projects.locations.repositories.html b/docs/dyn/dataform_v1.projects.locations.repositories.html
index 6f73a82a0a..6a40fe7dd0 100644
--- a/docs/dyn/dataform_v1.projects.locations.repositories.html
+++ b/docs/dyn/dataform_v1.projects.locations.repositories.html
@@ -241,7 +241,8 @@ Method Details
"displayName": "A String", # Optional. The repository's user-friendly name.
"gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
"authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
- "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.
+ "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used.
+ "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
"sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
"hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
"userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
@@ -284,7 +285,8 @@ Method Details
"displayName": "A String", # Optional. The repository's user-friendly name.
"gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
"authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
- "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.
+ "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used.
+ "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
"sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
"hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
"userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
@@ -419,7 +421,8 @@ Method Details
"displayName": "A String", # Optional. The repository's user-friendly name.
"gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
"authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
- "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.
+ "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used.
+ "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
"sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
"hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
"userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
@@ -510,7 +513,8 @@ Method Details
"displayName": "A String", # Optional. The repository's user-friendly name.
"gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
"authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
- "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.
+ "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used.
+ "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
"sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
"hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
"userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
@@ -615,7 +619,8 @@ Method Details
"displayName": "A String", # Optional. The repository's user-friendly name.
"gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
"authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
- "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.
+ "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used.
+ "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
"sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
"hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
"userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
@@ -658,7 +663,8 @@ Method Details
"displayName": "A String", # Optional. The repository's user-friendly name.
"gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
"authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
- "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.
+ "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used.
+ "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
"sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
"hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
"userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
@@ -705,8 +711,8 @@ Method Details
{ # `QueryRepositoryDirectoryContents` response message.
"directoryEntries": [ # List of entries in the directory.
{ # Represents a single entry in a directory.
- "directory": "A String", # A child directory in the directory.
- "file": "A String", # A file in the directory.
+ "directory": "A String", # A child directory in the directory. The path is returned including the full folder structure from the root.
+ "file": "A String", # A file in the directory. The path is returned including the full folder structure from the root.
"metadata": { # Represents metadata for a single entry in a filesystem. # Entry with metadata.
"sizeBytes": "A String", # Output only. Provides the size of the entry in bytes. For directories, this will be 0.
"updateTime": "A String", # Output only. Represents the time of the last modification of the entry.
diff --git a/docs/dyn/dataform_v1.projects.locations.repositories.workspaces.html b/docs/dyn/dataform_v1.projects.locations.repositories.workspaces.html
index b8dcbd64d2..823a8ccb68 100644
--- a/docs/dyn/dataform_v1.projects.locations.repositories.workspaces.html
+++ b/docs/dyn/dataform_v1.projects.locations.repositories.workspaces.html
@@ -621,8 +621,8 @@ Method Details
{ # `QueryDirectoryContents` response message.
"directoryEntries": [ # List of entries in the directory.
{ # Represents a single entry in a directory.
- "directory": "A String", # A child directory in the directory.
- "file": "A String", # A file in the directory.
+ "directory": "A String", # A child directory in the directory. The path is returned including the full folder structure from the root.
+ "file": "A String", # A file in the directory. The path is returned including the full folder structure from the root.
"metadata": { # Represents metadata for a single entry in a filesystem. # Entry with metadata.
"sizeBytes": "A String", # Output only. Provides the size of the entry in bytes. For directories, this will be 0.
"updateTime": "A String", # Output only. Represents the time of the last modification of the entry.
diff --git a/docs/dyn/dataform_v1.projects.locations.teamFolders.html b/docs/dyn/dataform_v1.projects.locations.teamFolders.html
index 8d388c465a..932905ce72 100644
--- a/docs/dyn/dataform_v1.projects.locations.teamFolders.html
+++ b/docs/dyn/dataform_v1.projects.locations.teamFolders.html
@@ -351,7 +351,8 @@ Method Details
"displayName": "A String", # Optional. The repository's user-friendly name.
"gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
"authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
- "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.
+ "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used.
+ "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
"sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
"hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
"userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
@@ -403,7 +404,7 @@ Method Details
location: string, Required. Location in which to query TeamFolders. Format: `projects/*/locations/*`. (required)
filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
orderBy: string, Optional. Field to additionally sort results by. Supported keywords: `display_name` (default), `create_time`, `last_modified_time`. Examples: * `orderBy="display_name"` * `orderBy="display_name desc"`
- pageSize: integer, Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+ pageSize: integer, Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick a default of page_size = 50.
pageToken: string, Optional. Page token received from a previous `SearchTeamFolders` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchTeamFolders`, with the exception of `page_size`, must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/dataform_v1beta1.projects.locations.folders.html b/docs/dyn/dataform_v1beta1.projects.locations.folders.html
index 1bf6634f0c..b4a47a61c3 100644
--- a/docs/dyn/dataform_v1beta1.projects.locations.folders.html
+++ b/docs/dyn/dataform_v1beta1.projects.locations.folders.html
@@ -401,7 +401,8 @@ Method Details
"displayName": "A String", # Optional. The repository's user-friendly name.
"gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
"authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
- "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.
+ "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used.
+ "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
"sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
"hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
"userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
diff --git a/docs/dyn/dataform_v1beta1.projects.locations.html b/docs/dyn/dataform_v1beta1.projects.locations.html
index a1ae6fd098..a647498163 100644
--- a/docs/dyn/dataform_v1beta1.projects.locations.html
+++ b/docs/dyn/dataform_v1beta1.projects.locations.html
@@ -262,7 +262,8 @@ Method Details
"displayName": "A String", # Optional. The repository's user-friendly name.
"gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
"authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
- "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.
+ "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used.
+ "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
"sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
"hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
"userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html
index 287c834e77..ab4fccbdbb 100644
--- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html
+++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html
@@ -114,6 +114,9 @@ Instance Methods
delete(name, force=None, x__xgafv=None)
Deletes a single Repository.
+
+ deleteLongRunning(name, body=None, x__xgafv=None)
+Deletes a single Repository asynchronously.
fetchHistory(name, pageSize=None, pageToken=None, x__xgafv=None)
Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.
@@ -241,7 +244,8 @@ Method Details
"displayName": "A String", # Optional. The repository's user-friendly name.
"gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
"authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
- "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.
+ "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used.
+ "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
"sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
"hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
"userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
@@ -284,7 +288,8 @@ Method Details
"displayName": "A String", # Optional. The repository's user-friendly name.
"gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
"authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
- "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.
+ "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used.
+ "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
"sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
"hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
"userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
@@ -329,6 +334,48 @@ Method Details
}
+
+ deleteLongRunning(name, body=None, x__xgafv=None)
+ Deletes a single Repository asynchronously.
+
+Args:
+ name: string, Required. The repository's name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # `DeleteRepositoryLongRunning` request message.
+ "force": True or False, # Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources. **Note:** *This flag doesn't support deletion of workspaces, release configs or workflow configs. If any of such resources exists in the repository, the request will fail.*
+}
+
+ 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.
+ },
+}
+
+
fetchHistory(name, pageSize=None, pageToken=None, x__xgafv=None)
Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.
@@ -419,7 +466,8 @@ Method Details
"displayName": "A String", # Optional. The repository's user-friendly name.
"gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
"authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
- "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.
+ "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used.
+ "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
"sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
"hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
"userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
@@ -510,7 +558,8 @@ Method Details
"displayName": "A String", # Optional. The repository's user-friendly name.
"gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
"authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
- "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.
+ "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used.
+ "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
"sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
"hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
"userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
@@ -615,7 +664,8 @@ Method Details
"displayName": "A String", # Optional. The repository's user-friendly name.
"gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
"authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
- "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.
+ "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used.
+ "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
"sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
"hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
"userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
@@ -658,7 +708,8 @@ Method Details
"displayName": "A String", # Optional. The repository's user-friendly name.
"gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
"authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
- "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.
+ "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used.
+ "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
"sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
"hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
"userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
@@ -705,8 +756,8 @@ Method Details
{ # `QueryRepositoryDirectoryContents` response message.
"directoryEntries": [ # List of entries in the directory.
{ # Represents a single entry in a directory.
- "directory": "A String", # A child directory in the directory.
- "file": "A String", # A file in the directory.
+ "directory": "A String", # A child directory in the directory. The path is returned including the full folder structure from the root.
+ "file": "A String", # A file in the directory. The path is returned including the full folder structure from the root.
"metadata": { # Represents metadata for a single entry in a filesystem. # Entry with metadata.
"sizeBytes": "A String", # Output only. Provides the size of the entry in bytes. For directories, this will be 0.
"updateTime": "A String", # Output only. Represents the time of the last modification of the entry.
diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html
index fc40fd8956..75ca5ac304 100644
--- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html
+++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html
@@ -621,8 +621,8 @@ Method Details
{ # `QueryDirectoryContents` response message.
"directoryEntries": [ # List of entries in the directory.
{ # Represents a single entry in a directory.
- "directory": "A String", # A child directory in the directory.
- "file": "A String", # A file in the directory.
+ "directory": "A String", # A child directory in the directory. The path is returned including the full folder structure from the root.
+ "file": "A String", # A file in the directory. The path is returned including the full folder structure from the root.
"metadata": { # Represents metadata for a single entry in a filesystem. # Entry with metadata.
"sizeBytes": "A String", # Output only. Provides the size of the entry in bytes. For directories, this will be 0.
"updateTime": "A String", # Output only. Represents the time of the last modification of the entry.
diff --git a/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html b/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html
index 899c63a353..2aabfb1854 100644
--- a/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html
+++ b/docs/dyn/dataform_v1beta1.projects.locations.teamFolders.html
@@ -352,7 +352,8 @@ Method Details
"displayName": "A String", # Optional. The repository's user-friendly name.
"gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
"authenticationTokenSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
- "defaultBranch": "A String", # Required. The Git remote's default branch name. If not set, `main` will be used and stored for the repository.
+ "defaultBranch": "A String", # Optional. The Git remote's default branch name. If not set `main` will be used.
+ "effectiveDefaultBranch": "A String", # Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
"sshAuthenticationConfig": { # Configures fields for performing SSH authentication. # Optional. Authentication fields for remote uris using SSH protocol.
"hostPublicKey": "A String", # Required. Content of a public SSH key to verify an identity of a remote Git host.
"userPrivateKeySecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as a ssh private key for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
@@ -404,7 +405,7 @@ Method Details
location: string, Required. Location in which to query TeamFolders. Format: `projects/*/locations/*`. (required)
filter: string, Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: * `filter="display_name="MyFolder""`
orderBy: string, Optional. Field to additionally sort results by. Supported keywords: `display_name` (default), `create_time`, `last_modified_time`. Examples: * `orderBy="display_name"` * `orderBy="display_name desc"`
- pageSize: integer, Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+ pageSize: integer, Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick a default of page_size = 50.
pageToken: string, Optional. Page token received from a previous `SearchTeamFolders` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchTeamFolders`, with the exception of `page_size`, must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/dataplex_v1.projects.locations.changeRequests.html b/docs/dyn/dataplex_v1.projects.locations.changeRequests.html
index 40d72cb394..57f298fe24 100644
--- a/docs/dyn/dataplex_v1.projects.locations.changeRequests.html
+++ b/docs/dyn/dataplex_v1.projects.locations.changeRequests.html
@@ -74,12 +74,33 @@
Cloud Dataplex API . projects . locations . changeRequests
Instance Methods
+
+ approve(name, body=None, x__xgafv=None)
+Approves a ChangeRequest.
Close httplib2 connections.
+
+ delete(name, etag=None, x__xgafv=None)
+Deletes a ChangeRequest.Behavior depends on the caller's permissions and the resource's state: 1. Callers with dataplex.changeRequests.delete can only delete ChangeRequests in the NEW state. 2. Callers with the dataplex.changeRequests.adminDelete permission can delete ChangeRequests regardless of their state.
+
+Gets a ChangeRequest.
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists ChangeRequests.
+
+Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Updates a ChangeRequest. Only allowed when the state is NEW.
+
+ reject(name, body=None, x__xgafv=None)
+Rejects a ChangeRequest.
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.
@@ -87,11 +108,607 @@ Instance Methods
testIamPermissions(resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Method Details
+
+ approve(name, body=None, x__xgafv=None)
+ Approves a ChangeRequest.
+
+Args:
+ name: string, Required. The name of the ChangeRequest to approve. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for ApproveChangeRequest.
+ "etag": "A String", # Optional. The etag of the ChangeRequest.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a proposed change to a metadata resource.
+ "approver": "A String", # Output only. The email address of the user who approved/rejected the ChangeRequest.
+ "author": "A String", # Output only. The email address of the user who created the ChangeRequest.
+ "changeType": "A String", # Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof.
+ "createEntry": { # Create Entry request. # Payload for creating an Entry.
+ "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+ "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+ "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
+ },
+ "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+ "createTime": "A String", # Output only. The time when the Aspect was created.
+ "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+ "a_key": "", # Properties of the object.
+ },
+ "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+ "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+ },
+ },
+ "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+ "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+ "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+ { # Information about individual items in the hierarchy that is associated with the data resource.
+ "name": "A String", # Optional. The name of the ancestor resource.
+ "type": "A String", # Optional. The type of the ancestor resource.
+ },
+ ],
+ "createTime": "A String", # The time when the resource was created in the source system.
+ "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+ "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+ "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+ "a_key": "A String",
+ },
+ "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+ "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+ "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+ "system": "A String", # The name of the source system. Maximum length is 64 characters.
+ "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+ },
+ "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+ "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+ "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+ },
+ "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters.
+ "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
+ },
+ "createEntryLink": { # Request message for CreateEntryLink. # Payload for creating an EntryLink.
+ "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource.
+ "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
+ "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
+ },
+ "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+ "createTime": "A String", # Output only. The time when the Aspect was created.
+ "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+ "a_key": "", # Properties of the object.
+ },
+ "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+ "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+ },
+ },
+ "createTime": "A String", # Output only. The time when the Entry Link was created.
+ "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
+ "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
+ { # Reference to the Entry that is linked through the Entry Link.
+ "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
+ "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
+ "type": "A String", # Required. Immutable. The reference type of the Entry.
+ },
+ ],
+ "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
+ "updateTime": "A String", # Output only. The time when the Entry Link was last updated.
+ },
+ "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup.
+ "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.
+ },
+ "createGlossary": { # Create Glossary Request # Payload for creating a Glossary.
+ "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to create.
+ "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+ "createTime": "A String", # Output only. The time at which the Glossary was created.
+ "description": "A String", # Optional. The user-mutable description of the Glossary.
+ "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+ "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "labels": { # Optional. User-defined labels for the Glossary.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+ "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+ },
+ "glossaryId": "A String", # Required. Glossary ID: Glossary identifier.
+ "parent": "A String", # Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.
+ "validateOnly": True or False, # Optional. Validates the request without actually creating the Glossary. Default: false.
+ },
+ "createGlossaryCategory": { # Creates a new GlossaryCategory under the specified Glossary. # Payload for creating a GlossaryCategory.
+ "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to create.
+ "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryCategory.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+ },
+ "categoryId": "A String", # Required. GlossaryCategory identifier.
+ "parent": "A String", # Required. The parent resource where this GlossaryCategory will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where locationId refers to a Google Cloud region.
+ },
+ "createGlossaryTerm": { # Creates a new GlossaryTerm under the specified Glossary. # Payload for creating a GlossaryTerm.
+ "parent": "A String", # Required. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.
+ "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to create.
+ "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryTerm.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+ },
+ "termId": "A String", # Required. GlossaryTerm identifier.
+ },
+ "createTime": "A String", # Output only. The time when the ChangeRequest was created.
+ "dataProductAccessRequest": { # Message for requesting access to a Data Product. This will be used to create a ChangeRequest of type REQUEST_DATA_PRODUCT_ACCESS. # Payload for Data Product access request.
+ "accessGroupDisplayName": "A String", # Output only. The display name of the access group defined in the Data Product for which access is being requested.
+ "accessGroupId": "A String", # Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product.
+ "parent": "A String", # Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}
+ "requestedPrincipal": "A String", # Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers
+ },
+ "deleteEntry": { # Delete Entry request. # Payload for deleting an Entry.
+ "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
+ },
+ "deleteEntryLink": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink.
+ "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.
+ },
+ "deleteGlossary": { # Delete Glossary Request # Payload for deleting a Glossary.
+ "etag": "A String", # Optional. The etag of the Glossary. If this is provided, it must match the server's etag. If the etag is provided and does not match the server-computed etag, the request must fail with a ABORTED error code.
+ "name": "A String", # Required. The name of the Glossary to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ },
+ "deleteGlossaryCategory": { # Delete GlossaryCategory Request # Payload for deleting a GlossaryCategory.
+ "name": "A String", # Required. The name of the GlossaryCategory to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ },
+ "deleteGlossaryTerm": { # Delete GlossaryTerm Request # Payload for deleting a GlossaryTerm.
+ "name": "A String", # Required. The name of the GlossaryTerm to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ },
+ "etag": "A String", # Optional. This checksum is computed by the service. It can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "justification": "A String", # Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved.
+ "labels": { # Optional. User-defined labels for the ChangeRequest.
+ "a_key": "A String",
+ },
+ "name": "A String", # Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}
+ "rejectionComment": "A String", # Output only. The reason provided for rejecting the ChangeRequest.
+ "resource": "A String", # Output only. The full resource name of the target resource to be modified. Example: //dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry
+ "state": "A String", # Output only. The current state of the ChangeRequest.
+ "uid": "A String", # Output only. System generated globally unique ID for the ChangeRequest.
+ "updateEntry": { # Update Entry request. # Payload for updating an Entry.
+ "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it.
+ "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.
+ "A String",
+ ],
+ "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.
+ "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+ "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+ "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
+ },
+ "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+ "createTime": "A String", # Output only. The time when the Aspect was created.
+ "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+ "a_key": "", # Properties of the object.
+ },
+ "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+ "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+ },
+ },
+ "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+ "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+ "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+ { # Information about individual items in the hierarchy that is associated with the data resource.
+ "name": "A String", # Optional. The name of the ancestor resource.
+ "type": "A String", # Optional. The type of the ancestor resource.
+ },
+ ],
+ "createTime": "A String", # The time when the resource was created in the source system.
+ "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+ "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+ "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+ "a_key": "A String",
+ },
+ "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+ "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+ "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+ "system": "A String", # The name of the source system. Maximum length is 64 characters.
+ "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+ },
+ "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+ "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+ "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+ },
+ "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request.
+ },
+ "updateGlossary": { # Update Glossary Request # Payload for updating a Glossary.
+ "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to update. The Glossary's name field is used to identify the Glossary to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+ "createTime": "A String", # Output only. The time at which the Glossary was created.
+ "description": "A String", # Optional. The user-mutable description of the Glossary.
+ "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+ "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "labels": { # Optional. User-defined labels for the Glossary.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+ "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+ },
+ "updateMask": "A String", # Required. The list of fields to update.
+ "validateOnly": True or False, # Optional. Validates the request without actually updating the Glossary. Default: false.
+ },
+ "updateGlossaryCategory": { # Update GlossaryCategory Request # Payload for updating a GlossaryCategory.
+ "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to update. The GlossaryCategory's name field is used to identify the GlossaryCategory to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryCategory.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+ },
+ "updateMask": "A String", # Required. The list of fields to update.
+ },
+ "updateGlossaryTerm": { # Update GlossaryTerm Request # Payload for updating a GlossaryTerm.
+ "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to update. The GlossaryTerm's name field is used to identify the GlossaryTerm to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryTerm.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+ },
+ "updateMask": "A String", # Required. The list of fields to update.
+ },
+ "updateTime": "A String", # Output only. The time when the ChangeRequest was last updated.
+}
+
+
close()
Close httplib2 connections.
+
+ delete(name, etag=None, x__xgafv=None)
+ Deletes a ChangeRequest.Behavior depends on the caller's permissions and the resource's state: 1. Callers with dataplex.changeRequests.delete can only delete ChangeRequests in the NEW state. 2. Callers with the dataplex.changeRequests.adminDelete permission can delete ChangeRequests regardless of their state.
+
+Args:
+ name: string, Required. The name of the ChangeRequest to delete. Format: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id} (required)
+ etag: string, Optional. The etag of the ChangeRequest.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+
+
+ get(name, x__xgafv=None)
+ Gets a ChangeRequest.
+
+Args:
+ name: string, Required. The name of the ChangeRequest to retrieve. Format: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a proposed change to a metadata resource.
+ "approver": "A String", # Output only. The email address of the user who approved/rejected the ChangeRequest.
+ "author": "A String", # Output only. The email address of the user who created the ChangeRequest.
+ "changeType": "A String", # Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof.
+ "createEntry": { # Create Entry request. # Payload for creating an Entry.
+ "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+ "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+ "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
+ },
+ "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+ "createTime": "A String", # Output only. The time when the Aspect was created.
+ "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+ "a_key": "", # Properties of the object.
+ },
+ "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+ "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+ },
+ },
+ "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+ "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+ "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+ { # Information about individual items in the hierarchy that is associated with the data resource.
+ "name": "A String", # Optional. The name of the ancestor resource.
+ "type": "A String", # Optional. The type of the ancestor resource.
+ },
+ ],
+ "createTime": "A String", # The time when the resource was created in the source system.
+ "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+ "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+ "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+ "a_key": "A String",
+ },
+ "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+ "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+ "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+ "system": "A String", # The name of the source system. Maximum length is 64 characters.
+ "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+ },
+ "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+ "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+ "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+ },
+ "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters.
+ "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
+ },
+ "createEntryLink": { # Request message for CreateEntryLink. # Payload for creating an EntryLink.
+ "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource.
+ "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
+ "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
+ },
+ "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+ "createTime": "A String", # Output only. The time when the Aspect was created.
+ "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+ "a_key": "", # Properties of the object.
+ },
+ "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+ "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+ },
+ },
+ "createTime": "A String", # Output only. The time when the Entry Link was created.
+ "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
+ "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
+ { # Reference to the Entry that is linked through the Entry Link.
+ "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
+ "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
+ "type": "A String", # Required. Immutable. The reference type of the Entry.
+ },
+ ],
+ "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
+ "updateTime": "A String", # Output only. The time when the Entry Link was last updated.
+ },
+ "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup.
+ "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.
+ },
+ "createGlossary": { # Create Glossary Request # Payload for creating a Glossary.
+ "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to create.
+ "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+ "createTime": "A String", # Output only. The time at which the Glossary was created.
+ "description": "A String", # Optional. The user-mutable description of the Glossary.
+ "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+ "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "labels": { # Optional. User-defined labels for the Glossary.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+ "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+ },
+ "glossaryId": "A String", # Required. Glossary ID: Glossary identifier.
+ "parent": "A String", # Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.
+ "validateOnly": True or False, # Optional. Validates the request without actually creating the Glossary. Default: false.
+ },
+ "createGlossaryCategory": { # Creates a new GlossaryCategory under the specified Glossary. # Payload for creating a GlossaryCategory.
+ "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to create.
+ "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryCategory.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+ },
+ "categoryId": "A String", # Required. GlossaryCategory identifier.
+ "parent": "A String", # Required. The parent resource where this GlossaryCategory will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where locationId refers to a Google Cloud region.
+ },
+ "createGlossaryTerm": { # Creates a new GlossaryTerm under the specified Glossary. # Payload for creating a GlossaryTerm.
+ "parent": "A String", # Required. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.
+ "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to create.
+ "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryTerm.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+ },
+ "termId": "A String", # Required. GlossaryTerm identifier.
+ },
+ "createTime": "A String", # Output only. The time when the ChangeRequest was created.
+ "dataProductAccessRequest": { # Message for requesting access to a Data Product. This will be used to create a ChangeRequest of type REQUEST_DATA_PRODUCT_ACCESS. # Payload for Data Product access request.
+ "accessGroupDisplayName": "A String", # Output only. The display name of the access group defined in the Data Product for which access is being requested.
+ "accessGroupId": "A String", # Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product.
+ "parent": "A String", # Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}
+ "requestedPrincipal": "A String", # Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers
+ },
+ "deleteEntry": { # Delete Entry request. # Payload for deleting an Entry.
+ "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
+ },
+ "deleteEntryLink": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink.
+ "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.
+ },
+ "deleteGlossary": { # Delete Glossary Request # Payload for deleting a Glossary.
+ "etag": "A String", # Optional. The etag of the Glossary. If this is provided, it must match the server's etag. If the etag is provided and does not match the server-computed etag, the request must fail with a ABORTED error code.
+ "name": "A String", # Required. The name of the Glossary to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ },
+ "deleteGlossaryCategory": { # Delete GlossaryCategory Request # Payload for deleting a GlossaryCategory.
+ "name": "A String", # Required. The name of the GlossaryCategory to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ },
+ "deleteGlossaryTerm": { # Delete GlossaryTerm Request # Payload for deleting a GlossaryTerm.
+ "name": "A String", # Required. The name of the GlossaryTerm to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ },
+ "etag": "A String", # Optional. This checksum is computed by the service. It can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "justification": "A String", # Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved.
+ "labels": { # Optional. User-defined labels for the ChangeRequest.
+ "a_key": "A String",
+ },
+ "name": "A String", # Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}
+ "rejectionComment": "A String", # Output only. The reason provided for rejecting the ChangeRequest.
+ "resource": "A String", # Output only. The full resource name of the target resource to be modified. Example: //dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry
+ "state": "A String", # Output only. The current state of the ChangeRequest.
+ "uid": "A String", # Output only. System generated globally unique ID for the ChangeRequest.
+ "updateEntry": { # Update Entry request. # Payload for updating an Entry.
+ "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it.
+ "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.
+ "A String",
+ ],
+ "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.
+ "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+ "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+ "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
+ },
+ "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+ "createTime": "A String", # Output only. The time when the Aspect was created.
+ "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+ "a_key": "", # Properties of the object.
+ },
+ "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+ "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+ },
+ },
+ "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+ "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+ "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+ { # Information about individual items in the hierarchy that is associated with the data resource.
+ "name": "A String", # Optional. The name of the ancestor resource.
+ "type": "A String", # Optional. The type of the ancestor resource.
+ },
+ ],
+ "createTime": "A String", # The time when the resource was created in the source system.
+ "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+ "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+ "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+ "a_key": "A String",
+ },
+ "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+ "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+ "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+ "system": "A String", # The name of the source system. Maximum length is 64 characters.
+ "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+ },
+ "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+ "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+ "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+ },
+ "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request.
+ },
+ "updateGlossary": { # Update Glossary Request # Payload for updating a Glossary.
+ "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to update. The Glossary's name field is used to identify the Glossary to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+ "createTime": "A String", # Output only. The time at which the Glossary was created.
+ "description": "A String", # Optional. The user-mutable description of the Glossary.
+ "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+ "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "labels": { # Optional. User-defined labels for the Glossary.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+ "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+ },
+ "updateMask": "A String", # Required. The list of fields to update.
+ "validateOnly": True or False, # Optional. Validates the request without actually updating the Glossary. Default: false.
+ },
+ "updateGlossaryCategory": { # Update GlossaryCategory Request # Payload for updating a GlossaryCategory.
+ "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to update. The GlossaryCategory's name field is used to identify the GlossaryCategory to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryCategory.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+ },
+ "updateMask": "A String", # Required. The list of fields to update.
+ },
+ "updateGlossaryTerm": { # Update GlossaryTerm Request # Payload for updating a GlossaryTerm.
+ "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to update. The GlossaryTerm's name field is used to identify the GlossaryTerm to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryTerm.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+ },
+ "updateMask": "A String", # Required. The list of fields to update.
+ },
+ "updateTime": "A String", # Output only. The time when the ChangeRequest was last updated.
+}
+
+
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.
@@ -140,6 +757,1169 @@ Method Details
}
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists ChangeRequests.
+
+Args:
+ parent: string, Required. The parent, which owns this collection of ChangeRequests. Format: projects/{project_number}/locations/{location_id} (required)
+ filter: string, Optional. Filter request. Supports filtering by: state, author, resource, create_time, update_time.
+ orderBy: string, Optional. Order by fields for the result.
+ pageSize: integer, Optional. Maximum number of ChangeRequests to return. The service may return fewer.
+ pageToken: string, Optional. Page token received from a previous ListChangeRequests call.
+ 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 ListChangeRequests.
+ "changeRequests": [ # The ChangeRequests from the specified project and location.
+ { # Represents a proposed change to a metadata resource.
+ "approver": "A String", # Output only. The email address of the user who approved/rejected the ChangeRequest.
+ "author": "A String", # Output only. The email address of the user who created the ChangeRequest.
+ "changeType": "A String", # Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof.
+ "createEntry": { # Create Entry request. # Payload for creating an Entry.
+ "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+ "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+ "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
+ },
+ "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+ "createTime": "A String", # Output only. The time when the Aspect was created.
+ "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+ "a_key": "", # Properties of the object.
+ },
+ "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+ "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+ },
+ },
+ "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+ "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+ "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+ { # Information about individual items in the hierarchy that is associated with the data resource.
+ "name": "A String", # Optional. The name of the ancestor resource.
+ "type": "A String", # Optional. The type of the ancestor resource.
+ },
+ ],
+ "createTime": "A String", # The time when the resource was created in the source system.
+ "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+ "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+ "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+ "a_key": "A String",
+ },
+ "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+ "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+ "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+ "system": "A String", # The name of the source system. Maximum length is 64 characters.
+ "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+ },
+ "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+ "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+ "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+ },
+ "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters.
+ "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
+ },
+ "createEntryLink": { # Request message for CreateEntryLink. # Payload for creating an EntryLink.
+ "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource.
+ "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
+ "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
+ },
+ "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+ "createTime": "A String", # Output only. The time when the Aspect was created.
+ "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+ "a_key": "", # Properties of the object.
+ },
+ "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+ "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+ },
+ },
+ "createTime": "A String", # Output only. The time when the Entry Link was created.
+ "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
+ "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
+ { # Reference to the Entry that is linked through the Entry Link.
+ "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
+ "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
+ "type": "A String", # Required. Immutable. The reference type of the Entry.
+ },
+ ],
+ "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
+ "updateTime": "A String", # Output only. The time when the Entry Link was last updated.
+ },
+ "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup.
+ "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.
+ },
+ "createGlossary": { # Create Glossary Request # Payload for creating a Glossary.
+ "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to create.
+ "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+ "createTime": "A String", # Output only. The time at which the Glossary was created.
+ "description": "A String", # Optional. The user-mutable description of the Glossary.
+ "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+ "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "labels": { # Optional. User-defined labels for the Glossary.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+ "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+ },
+ "glossaryId": "A String", # Required. Glossary ID: Glossary identifier.
+ "parent": "A String", # Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.
+ "validateOnly": True or False, # Optional. Validates the request without actually creating the Glossary. Default: false.
+ },
+ "createGlossaryCategory": { # Creates a new GlossaryCategory under the specified Glossary. # Payload for creating a GlossaryCategory.
+ "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to create.
+ "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryCategory.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+ },
+ "categoryId": "A String", # Required. GlossaryCategory identifier.
+ "parent": "A String", # Required. The parent resource where this GlossaryCategory will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where locationId refers to a Google Cloud region.
+ },
+ "createGlossaryTerm": { # Creates a new GlossaryTerm under the specified Glossary. # Payload for creating a GlossaryTerm.
+ "parent": "A String", # Required. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.
+ "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to create.
+ "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryTerm.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+ },
+ "termId": "A String", # Required. GlossaryTerm identifier.
+ },
+ "createTime": "A String", # Output only. The time when the ChangeRequest was created.
+ "dataProductAccessRequest": { # Message for requesting access to a Data Product. This will be used to create a ChangeRequest of type REQUEST_DATA_PRODUCT_ACCESS. # Payload for Data Product access request.
+ "accessGroupDisplayName": "A String", # Output only. The display name of the access group defined in the Data Product for which access is being requested.
+ "accessGroupId": "A String", # Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product.
+ "parent": "A String", # Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}
+ "requestedPrincipal": "A String", # Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers
+ },
+ "deleteEntry": { # Delete Entry request. # Payload for deleting an Entry.
+ "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
+ },
+ "deleteEntryLink": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink.
+ "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.
+ },
+ "deleteGlossary": { # Delete Glossary Request # Payload for deleting a Glossary.
+ "etag": "A String", # Optional. The etag of the Glossary. If this is provided, it must match the server's etag. If the etag is provided and does not match the server-computed etag, the request must fail with a ABORTED error code.
+ "name": "A String", # Required. The name of the Glossary to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ },
+ "deleteGlossaryCategory": { # Delete GlossaryCategory Request # Payload for deleting a GlossaryCategory.
+ "name": "A String", # Required. The name of the GlossaryCategory to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ },
+ "deleteGlossaryTerm": { # Delete GlossaryTerm Request # Payload for deleting a GlossaryTerm.
+ "name": "A String", # Required. The name of the GlossaryTerm to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ },
+ "etag": "A String", # Optional. This checksum is computed by the service. It can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "justification": "A String", # Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved.
+ "labels": { # Optional. User-defined labels for the ChangeRequest.
+ "a_key": "A String",
+ },
+ "name": "A String", # Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}
+ "rejectionComment": "A String", # Output only. The reason provided for rejecting the ChangeRequest.
+ "resource": "A String", # Output only. The full resource name of the target resource to be modified. Example: //dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry
+ "state": "A String", # Output only. The current state of the ChangeRequest.
+ "uid": "A String", # Output only. System generated globally unique ID for the ChangeRequest.
+ "updateEntry": { # Update Entry request. # Payload for updating an Entry.
+ "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it.
+ "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.
+ "A String",
+ ],
+ "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.
+ "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+ "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+ "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
+ },
+ "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+ "createTime": "A String", # Output only. The time when the Aspect was created.
+ "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+ "a_key": "", # Properties of the object.
+ },
+ "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+ "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+ },
+ },
+ "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+ "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+ "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+ { # Information about individual items in the hierarchy that is associated with the data resource.
+ "name": "A String", # Optional. The name of the ancestor resource.
+ "type": "A String", # Optional. The type of the ancestor resource.
+ },
+ ],
+ "createTime": "A String", # The time when the resource was created in the source system.
+ "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+ "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+ "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+ "a_key": "A String",
+ },
+ "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+ "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+ "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+ "system": "A String", # The name of the source system. Maximum length is 64 characters.
+ "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+ },
+ "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+ "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+ "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+ },
+ "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request.
+ },
+ "updateGlossary": { # Update Glossary Request # Payload for updating a Glossary.
+ "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to update. The Glossary's name field is used to identify the Glossary to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+ "createTime": "A String", # Output only. The time at which the Glossary was created.
+ "description": "A String", # Optional. The user-mutable description of the Glossary.
+ "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+ "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "labels": { # Optional. User-defined labels for the Glossary.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+ "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+ },
+ "updateMask": "A String", # Required. The list of fields to update.
+ "validateOnly": True or False, # Optional. Validates the request without actually updating the Glossary. Default: false.
+ },
+ "updateGlossaryCategory": { # Update GlossaryCategory Request # Payload for updating a GlossaryCategory.
+ "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to update. The GlossaryCategory's name field is used to identify the GlossaryCategory to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryCategory.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+ },
+ "updateMask": "A String", # Required. The list of fields to update.
+ },
+ "updateGlossaryTerm": { # Update GlossaryTerm Request # Payload for updating a GlossaryTerm.
+ "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to update. The GlossaryTerm's name field is used to identify the GlossaryTerm to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryTerm.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+ },
+ "updateMask": "A String", # Required. The list of fields to update.
+ },
+ "updateTime": "A String", # Output only. The time when the ChangeRequest was last updated.
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as page_token to retrieve the next page.
+ "unreachable": [ # Locations that could not be reached.
+ "A String",
+ ],
+}
+
+
+
+ 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.
+
+
+
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates a ChangeRequest. Only allowed when the state is NEW.
+
+Args:
+ name: string, Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a proposed change to a metadata resource.
+ "approver": "A String", # Output only. The email address of the user who approved/rejected the ChangeRequest.
+ "author": "A String", # Output only. The email address of the user who created the ChangeRequest.
+ "changeType": "A String", # Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof.
+ "createEntry": { # Create Entry request. # Payload for creating an Entry.
+ "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+ "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+ "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
+ },
+ "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+ "createTime": "A String", # Output only. The time when the Aspect was created.
+ "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+ "a_key": "", # Properties of the object.
+ },
+ "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+ "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+ },
+ },
+ "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+ "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+ "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+ { # Information about individual items in the hierarchy that is associated with the data resource.
+ "name": "A String", # Optional. The name of the ancestor resource.
+ "type": "A String", # Optional. The type of the ancestor resource.
+ },
+ ],
+ "createTime": "A String", # The time when the resource was created in the source system.
+ "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+ "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+ "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+ "a_key": "A String",
+ },
+ "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+ "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+ "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+ "system": "A String", # The name of the source system. Maximum length is 64 characters.
+ "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+ },
+ "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+ "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+ "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+ },
+ "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters.
+ "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
+ },
+ "createEntryLink": { # Request message for CreateEntryLink. # Payload for creating an EntryLink.
+ "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource.
+ "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
+ "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
+ },
+ "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+ "createTime": "A String", # Output only. The time when the Aspect was created.
+ "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+ "a_key": "", # Properties of the object.
+ },
+ "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+ "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+ },
+ },
+ "createTime": "A String", # Output only. The time when the Entry Link was created.
+ "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
+ "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
+ { # Reference to the Entry that is linked through the Entry Link.
+ "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
+ "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
+ "type": "A String", # Required. Immutable. The reference type of the Entry.
+ },
+ ],
+ "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
+ "updateTime": "A String", # Output only. The time when the Entry Link was last updated.
+ },
+ "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup.
+ "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.
+ },
+ "createGlossary": { # Create Glossary Request # Payload for creating a Glossary.
+ "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to create.
+ "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+ "createTime": "A String", # Output only. The time at which the Glossary was created.
+ "description": "A String", # Optional. The user-mutable description of the Glossary.
+ "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+ "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "labels": { # Optional. User-defined labels for the Glossary.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+ "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+ },
+ "glossaryId": "A String", # Required. Glossary ID: Glossary identifier.
+ "parent": "A String", # Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.
+ "validateOnly": True or False, # Optional. Validates the request without actually creating the Glossary. Default: false.
+ },
+ "createGlossaryCategory": { # Creates a new GlossaryCategory under the specified Glossary. # Payload for creating a GlossaryCategory.
+ "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to create.
+ "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryCategory.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+ },
+ "categoryId": "A String", # Required. GlossaryCategory identifier.
+ "parent": "A String", # Required. The parent resource where this GlossaryCategory will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where locationId refers to a Google Cloud region.
+ },
+ "createGlossaryTerm": { # Creates a new GlossaryTerm under the specified Glossary. # Payload for creating a GlossaryTerm.
+ "parent": "A String", # Required. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.
+ "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to create.
+ "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryTerm.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+ },
+ "termId": "A String", # Required. GlossaryTerm identifier.
+ },
+ "createTime": "A String", # Output only. The time when the ChangeRequest was created.
+ "dataProductAccessRequest": { # Message for requesting access to a Data Product. This will be used to create a ChangeRequest of type REQUEST_DATA_PRODUCT_ACCESS. # Payload for Data Product access request.
+ "accessGroupDisplayName": "A String", # Output only. The display name of the access group defined in the Data Product for which access is being requested.
+ "accessGroupId": "A String", # Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product.
+ "parent": "A String", # Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}
+ "requestedPrincipal": "A String", # Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers
+ },
+ "deleteEntry": { # Delete Entry request. # Payload for deleting an Entry.
+ "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
+ },
+ "deleteEntryLink": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink.
+ "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.
+ },
+ "deleteGlossary": { # Delete Glossary Request # Payload for deleting a Glossary.
+ "etag": "A String", # Optional. The etag of the Glossary. If this is provided, it must match the server's etag. If the etag is provided and does not match the server-computed etag, the request must fail with a ABORTED error code.
+ "name": "A String", # Required. The name of the Glossary to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ },
+ "deleteGlossaryCategory": { # Delete GlossaryCategory Request # Payload for deleting a GlossaryCategory.
+ "name": "A String", # Required. The name of the GlossaryCategory to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ },
+ "deleteGlossaryTerm": { # Delete GlossaryTerm Request # Payload for deleting a GlossaryTerm.
+ "name": "A String", # Required. The name of the GlossaryTerm to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ },
+ "etag": "A String", # Optional. This checksum is computed by the service. It can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "justification": "A String", # Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved.
+ "labels": { # Optional. User-defined labels for the ChangeRequest.
+ "a_key": "A String",
+ },
+ "name": "A String", # Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}
+ "rejectionComment": "A String", # Output only. The reason provided for rejecting the ChangeRequest.
+ "resource": "A String", # Output only. The full resource name of the target resource to be modified. Example: //dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry
+ "state": "A String", # Output only. The current state of the ChangeRequest.
+ "uid": "A String", # Output only. System generated globally unique ID for the ChangeRequest.
+ "updateEntry": { # Update Entry request. # Payload for updating an Entry.
+ "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it.
+ "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.
+ "A String",
+ ],
+ "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.
+ "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+ "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+ "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
+ },
+ "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+ "createTime": "A String", # Output only. The time when the Aspect was created.
+ "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+ "a_key": "", # Properties of the object.
+ },
+ "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+ "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+ },
+ },
+ "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+ "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+ "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+ { # Information about individual items in the hierarchy that is associated with the data resource.
+ "name": "A String", # Optional. The name of the ancestor resource.
+ "type": "A String", # Optional. The type of the ancestor resource.
+ },
+ ],
+ "createTime": "A String", # The time when the resource was created in the source system.
+ "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+ "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+ "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+ "a_key": "A String",
+ },
+ "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+ "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+ "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+ "system": "A String", # The name of the source system. Maximum length is 64 characters.
+ "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+ },
+ "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+ "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+ "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+ },
+ "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request.
+ },
+ "updateGlossary": { # Update Glossary Request # Payload for updating a Glossary.
+ "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to update. The Glossary's name field is used to identify the Glossary to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+ "createTime": "A String", # Output only. The time at which the Glossary was created.
+ "description": "A String", # Optional. The user-mutable description of the Glossary.
+ "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+ "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "labels": { # Optional. User-defined labels for the Glossary.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+ "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+ },
+ "updateMask": "A String", # Required. The list of fields to update.
+ "validateOnly": True or False, # Optional. Validates the request without actually updating the Glossary. Default: false.
+ },
+ "updateGlossaryCategory": { # Update GlossaryCategory Request # Payload for updating a GlossaryCategory.
+ "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to update. The GlossaryCategory's name field is used to identify the GlossaryCategory to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryCategory.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+ },
+ "updateMask": "A String", # Required. The list of fields to update.
+ },
+ "updateGlossaryTerm": { # Update GlossaryTerm Request # Payload for updating a GlossaryTerm.
+ "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to update. The GlossaryTerm's name field is used to identify the GlossaryTerm to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryTerm.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+ },
+ "updateMask": "A String", # Required. The list of fields to update.
+ },
+ "updateTime": "A String", # Output only. The time when the ChangeRequest was last updated.
+}
+
+ updateMask: string, Optional. The list of fields to update.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a proposed change to a metadata resource.
+ "approver": "A String", # Output only. The email address of the user who approved/rejected the ChangeRequest.
+ "author": "A String", # Output only. The email address of the user who created the ChangeRequest.
+ "changeType": "A String", # Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof.
+ "createEntry": { # Create Entry request. # Payload for creating an Entry.
+ "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+ "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+ "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
+ },
+ "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+ "createTime": "A String", # Output only. The time when the Aspect was created.
+ "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+ "a_key": "", # Properties of the object.
+ },
+ "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+ "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+ },
+ },
+ "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+ "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+ "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+ { # Information about individual items in the hierarchy that is associated with the data resource.
+ "name": "A String", # Optional. The name of the ancestor resource.
+ "type": "A String", # Optional. The type of the ancestor resource.
+ },
+ ],
+ "createTime": "A String", # The time when the resource was created in the source system.
+ "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+ "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+ "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+ "a_key": "A String",
+ },
+ "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+ "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+ "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+ "system": "A String", # The name of the source system. Maximum length is 64 characters.
+ "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+ },
+ "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+ "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+ "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+ },
+ "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters.
+ "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
+ },
+ "createEntryLink": { # Request message for CreateEntryLink. # Payload for creating an EntryLink.
+ "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource.
+ "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
+ "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
+ },
+ "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+ "createTime": "A String", # Output only. The time when the Aspect was created.
+ "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+ "a_key": "", # Properties of the object.
+ },
+ "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+ "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+ },
+ },
+ "createTime": "A String", # Output only. The time when the Entry Link was created.
+ "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
+ "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
+ { # Reference to the Entry that is linked through the Entry Link.
+ "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
+ "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
+ "type": "A String", # Required. Immutable. The reference type of the Entry.
+ },
+ ],
+ "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
+ "updateTime": "A String", # Output only. The time when the Entry Link was last updated.
+ },
+ "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup.
+ "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.
+ },
+ "createGlossary": { # Create Glossary Request # Payload for creating a Glossary.
+ "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to create.
+ "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+ "createTime": "A String", # Output only. The time at which the Glossary was created.
+ "description": "A String", # Optional. The user-mutable description of the Glossary.
+ "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+ "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "labels": { # Optional. User-defined labels for the Glossary.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+ "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+ },
+ "glossaryId": "A String", # Required. Glossary ID: Glossary identifier.
+ "parent": "A String", # Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.
+ "validateOnly": True or False, # Optional. Validates the request without actually creating the Glossary. Default: false.
+ },
+ "createGlossaryCategory": { # Creates a new GlossaryCategory under the specified Glossary. # Payload for creating a GlossaryCategory.
+ "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to create.
+ "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryCategory.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+ },
+ "categoryId": "A String", # Required. GlossaryCategory identifier.
+ "parent": "A String", # Required. The parent resource where this GlossaryCategory will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where locationId refers to a Google Cloud region.
+ },
+ "createGlossaryTerm": { # Creates a new GlossaryTerm under the specified Glossary. # Payload for creating a GlossaryTerm.
+ "parent": "A String", # Required. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.
+ "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to create.
+ "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryTerm.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+ },
+ "termId": "A String", # Required. GlossaryTerm identifier.
+ },
+ "createTime": "A String", # Output only. The time when the ChangeRequest was created.
+ "dataProductAccessRequest": { # Message for requesting access to a Data Product. This will be used to create a ChangeRequest of type REQUEST_DATA_PRODUCT_ACCESS. # Payload for Data Product access request.
+ "accessGroupDisplayName": "A String", # Output only. The display name of the access group defined in the Data Product for which access is being requested.
+ "accessGroupId": "A String", # Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product.
+ "parent": "A String", # Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}
+ "requestedPrincipal": "A String", # Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers
+ },
+ "deleteEntry": { # Delete Entry request. # Payload for deleting an Entry.
+ "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
+ },
+ "deleteEntryLink": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink.
+ "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.
+ },
+ "deleteGlossary": { # Delete Glossary Request # Payload for deleting a Glossary.
+ "etag": "A String", # Optional. The etag of the Glossary. If this is provided, it must match the server's etag. If the etag is provided and does not match the server-computed etag, the request must fail with a ABORTED error code.
+ "name": "A String", # Required. The name of the Glossary to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ },
+ "deleteGlossaryCategory": { # Delete GlossaryCategory Request # Payload for deleting a GlossaryCategory.
+ "name": "A String", # Required. The name of the GlossaryCategory to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ },
+ "deleteGlossaryTerm": { # Delete GlossaryTerm Request # Payload for deleting a GlossaryTerm.
+ "name": "A String", # Required. The name of the GlossaryTerm to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ },
+ "etag": "A String", # Optional. This checksum is computed by the service. It can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "justification": "A String", # Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved.
+ "labels": { # Optional. User-defined labels for the ChangeRequest.
+ "a_key": "A String",
+ },
+ "name": "A String", # Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}
+ "rejectionComment": "A String", # Output only. The reason provided for rejecting the ChangeRequest.
+ "resource": "A String", # Output only. The full resource name of the target resource to be modified. Example: //dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry
+ "state": "A String", # Output only. The current state of the ChangeRequest.
+ "uid": "A String", # Output only. System generated globally unique ID for the ChangeRequest.
+ "updateEntry": { # Update Entry request. # Payload for updating an Entry.
+ "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it.
+ "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.
+ "A String",
+ ],
+ "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.
+ "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+ "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+ "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
+ },
+ "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+ "createTime": "A String", # Output only. The time when the Aspect was created.
+ "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+ "a_key": "", # Properties of the object.
+ },
+ "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+ "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+ },
+ },
+ "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+ "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+ "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+ { # Information about individual items in the hierarchy that is associated with the data resource.
+ "name": "A String", # Optional. The name of the ancestor resource.
+ "type": "A String", # Optional. The type of the ancestor resource.
+ },
+ ],
+ "createTime": "A String", # The time when the resource was created in the source system.
+ "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+ "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+ "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+ "a_key": "A String",
+ },
+ "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+ "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+ "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+ "system": "A String", # The name of the source system. Maximum length is 64 characters.
+ "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+ },
+ "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+ "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+ "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+ },
+ "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request.
+ },
+ "updateGlossary": { # Update Glossary Request # Payload for updating a Glossary.
+ "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to update. The Glossary's name field is used to identify the Glossary to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+ "createTime": "A String", # Output only. The time at which the Glossary was created.
+ "description": "A String", # Optional. The user-mutable description of the Glossary.
+ "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+ "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "labels": { # Optional. User-defined labels for the Glossary.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+ "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+ },
+ "updateMask": "A String", # Required. The list of fields to update.
+ "validateOnly": True or False, # Optional. Validates the request without actually updating the Glossary. Default: false.
+ },
+ "updateGlossaryCategory": { # Update GlossaryCategory Request # Payload for updating a GlossaryCategory.
+ "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to update. The GlossaryCategory's name field is used to identify the GlossaryCategory to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryCategory.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+ },
+ "updateMask": "A String", # Required. The list of fields to update.
+ },
+ "updateGlossaryTerm": { # Update GlossaryTerm Request # Payload for updating a GlossaryTerm.
+ "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to update. The GlossaryTerm's name field is used to identify the GlossaryTerm to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryTerm.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+ },
+ "updateMask": "A String", # Required. The list of fields to update.
+ },
+ "updateTime": "A String", # Output only. The time when the ChangeRequest was last updated.
+}
+
+
+
+ reject(name, body=None, x__xgafv=None)
+ Rejects a ChangeRequest.
+
+Args:
+ name: string, Required. The name of the ChangeRequest to reject. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for RejectChangeRequest.
+ "comment": "A String", # Optional. The reason for rejecting the ChangeRequest.
+ "etag": "A String", # Optional. The etag of the ChangeRequest.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a proposed change to a metadata resource.
+ "approver": "A String", # Output only. The email address of the user who approved/rejected the ChangeRequest.
+ "author": "A String", # Output only. The email address of the user who created the ChangeRequest.
+ "changeType": "A String", # Output only. The type of change represented by the change_payload. This field is derived from the populated field in the change_payload oneof.
+ "createEntry": { # Create Entry request. # Payload for creating an Entry.
+ "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+ "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+ "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
+ },
+ "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+ "createTime": "A String", # Output only. The time when the Aspect was created.
+ "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+ "a_key": "", # Properties of the object.
+ },
+ "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+ "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+ },
+ },
+ "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+ "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+ "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+ { # Information about individual items in the hierarchy that is associated with the data resource.
+ "name": "A String", # Optional. The name of the ancestor resource.
+ "type": "A String", # Optional. The type of the ancestor resource.
+ },
+ ],
+ "createTime": "A String", # The time when the resource was created in the source system.
+ "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+ "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+ "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+ "a_key": "A String",
+ },
+ "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+ "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+ "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+ "system": "A String", # The name of the source system. Maximum length is 64 characters.
+ "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+ },
+ "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+ "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+ "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+ },
+ "entryId": "A String", # Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters.
+ "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.
+ },
+ "createEntryLink": { # Request message for CreateEntryLink. # Payload for creating an EntryLink.
+ "entryLink": { # EntryLink represents a link between two Entries. # Required. Entry Link resource.
+ "aspects": { # Optional. The aspects that are attached to the entry link. The format of the aspect key has to be the following: {project_id_or_number}.{location_id}.{aspect_type_id} Currently, only a single aspect of a Dataplex-owned Aspect Type is allowed.
+ "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
+ },
+ "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+ "createTime": "A String", # Output only. The time when the Aspect was created.
+ "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+ "a_key": "", # Properties of the object.
+ },
+ "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+ "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+ },
+ },
+ "createTime": "A String", # Output only. The time when the Entry Link was created.
+ "entryLinkType": "A String", # Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link. For example: Entry link between synonym terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/synonym Entry link between related terms in a glossary: projects/dataplex-types/locations/global/entryLinkTypes/related Entry link between glossary terms and data assets: projects/dataplex-types/locations/global/entryLinkTypes/definition
+ "entryReferences": [ # Required. Immutable. Specifies the Entries referenced in the Entry Link. There should be exactly two entry references.
+ { # Reference to the Entry that is linked through the Entry Link.
+ "name": "A String", # Required. Immutable. The relative resource name of the referenced Entry, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}
+ "path": "A String", # Immutable. The path in the Entry that is referenced in the Entry Link. Empty path denotes that the Entry itself is referenced in the Entry Link.
+ "type": "A String", # Required. Immutable. The reference type of the Entry.
+ },
+ ],
+ "name": "A String", # Output only. Immutable. Identifier. The relative resource name of the Entry Link, of the form: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}
+ "updateTime": "A String", # Output only. The time when the Entry Link was last updated.
+ },
+ "entryLinkId": "A String", # Required. Entry Link identifier * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the EntryGroup.
+ "parent": "A String", # Required. The resource name of the parent Entry Group: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.
+ },
+ "createGlossary": { # Create Glossary Request # Payload for creating a Glossary.
+ "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to create.
+ "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+ "createTime": "A String", # Output only. The time at which the Glossary was created.
+ "description": "A String", # Optional. The user-mutable description of the Glossary.
+ "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+ "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "labels": { # Optional. User-defined labels for the Glossary.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+ "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+ },
+ "glossaryId": "A String", # Required. Glossary ID: Glossary identifier.
+ "parent": "A String", # Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.
+ "validateOnly": True or False, # Optional. Validates the request without actually creating the Glossary. Default: false.
+ },
+ "createGlossaryCategory": { # Creates a new GlossaryCategory under the specified Glossary. # Payload for creating a GlossaryCategory.
+ "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to create.
+ "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryCategory.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+ },
+ "categoryId": "A String", # Required. GlossaryCategory identifier.
+ "parent": "A String", # Required. The parent resource where this GlossaryCategory will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where locationId refers to a Google Cloud region.
+ },
+ "createGlossaryTerm": { # Creates a new GlossaryTerm under the specified Glossary. # Payload for creating a GlossaryTerm.
+ "parent": "A String", # Required. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.
+ "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to create.
+ "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryTerm.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+ },
+ "termId": "A String", # Required. GlossaryTerm identifier.
+ },
+ "createTime": "A String", # Output only. The time when the ChangeRequest was created.
+ "dataProductAccessRequest": { # Message for requesting access to a Data Product. This will be used to create a ChangeRequest of type REQUEST_DATA_PRODUCT_ACCESS. # Payload for Data Product access request.
+ "accessGroupDisplayName": "A String", # Output only. The display name of the access group defined in the Data Product for which access is being requested.
+ "accessGroupId": "A String", # Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product.
+ "parent": "A String", # Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}
+ "requestedPrincipal": "A String", # Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers
+ },
+ "deleteEntry": { # Delete Entry request. # Payload for deleting an Entry.
+ "name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
+ },
+ "deleteEntryLink": { # Request message for DeleteEntryLink. # Payload for deleting an EntryLink.
+ "name": "A String", # Required. The resource name of the Entry Link: projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entryLinks/{entry_link_id}.
+ },
+ "deleteGlossary": { # Delete Glossary Request # Payload for deleting a Glossary.
+ "etag": "A String", # Optional. The etag of the Glossary. If this is provided, it must match the server's etag. If the etag is provided and does not match the server-computed etag, the request must fail with a ABORTED error code.
+ "name": "A String", # Required. The name of the Glossary to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ },
+ "deleteGlossaryCategory": { # Delete GlossaryCategory Request # Payload for deleting a GlossaryCategory.
+ "name": "A String", # Required. The name of the GlossaryCategory to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ },
+ "deleteGlossaryTerm": { # Delete GlossaryTerm Request # Payload for deleting a GlossaryTerm.
+ "name": "A String", # Required. The name of the GlossaryTerm to delete. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ },
+ "etag": "A String", # Optional. This checksum is computed by the service. It can be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "justification": "A String", # Optional. Justification of the ChangeRequest. This should explain why the change is needed or why it should be approved.
+ "labels": { # Optional. User-defined labels for the ChangeRequest.
+ "a_key": "A String",
+ },
+ "name": "A String", # Identifier. The relative resource name of the ChangeRequest, of the form: projects/{project_number}/locations/{location_id}/changeRequests/{change_request_id}
+ "rejectionComment": "A String", # Output only. The reason provided for rejecting the ChangeRequest.
+ "resource": "A String", # Output only. The full resource name of the target resource to be modified. Example: //dataplex.googleapis.com/projects/my-project/locations/us-central1/entryGroups/my-group/entries/my-entry
+ "state": "A String", # Output only. The current state of the ChangeRequest.
+ "uid": "A String", # Output only. System generated globally unique ID for the ChangeRequest.
+ "updateEntry": { # Update Entry request. # Payload for updating an Entry.
+ "allowMissing": True or False, # Optional. If set to true and the entry doesn't exist, the service will create it.
+ "aspectKeys": [ # Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. @* - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.
+ "A String",
+ ],
+ "deleteMissingAspects": True or False, # Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.
+ "entry": { # An entry is a representation of a data resource that can be described by various metadata. # Required. Entry resource.
+ "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
+ "a_key": { # Represents a single piece of metadata describing an entry or entry link.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "dataVersion": "A String", # The version of the data format used to produce this data. This field is used to indicated when the underlying data format changes (e.g., schema modifications, changes to the source URL format definition, etc).
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
+ },
+ "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
+ "createTime": "A String", # Output only. The time when the Aspect was created.
+ "data": { # Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).
+ "a_key": "", # Properties of the object.
+ },
+ "path": "A String", # Output only. The path in the entry under which the aspect is attached.
+ "updateTime": "A String", # Output only. The time when the Aspect was last updated.
+ },
+ },
+ "createTime": "A String", # Output only. The time when the entry was created in Dataplex Universal Catalog.
+ "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+ "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+ { # Information about individual items in the hierarchy that is associated with the data resource.
+ "name": "A String", # Optional. The name of the ancestor resource.
+ "type": "A String", # Optional. The type of the ancestor resource.
+ },
+ ],
+ "createTime": "A String", # The time when the resource was created in the source system.
+ "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+ "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
+ "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
+ "a_key": "A String",
+ },
+ "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+ "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+ "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+ "system": "A String", # The name of the source system. Maximum length is 64 characters.
+ "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
+ },
+ "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+ "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.
+ "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
+ "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex Universal Catalog.
+ },
+ "updateMask": "A String", # Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request.
+ },
+ "updateGlossary": { # Update Glossary Request # Payload for updating a Glossary.
+ "glossary": { # A Glossary represents a collection of GlossaryCategories and GlossaryTerms defined by the user. Glossary is a top level resource and is the Google Cloud parent resource of all the GlossaryCategories and GlossaryTerms within it. # Required. The Glossary to update. The Glossary's name field is used to identify the Glossary to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ "categoryCount": 42, # Output only. The number of GlossaryCategories in the Glossary.
+ "createTime": "A String", # Output only. The time at which the Glossary was created.
+ "description": "A String", # Optional. The user-mutable description of the Glossary.
+ "displayName": "A String", # Optional. User friendly display name of the Glossary. This is user-mutable. This will be same as the GlossaryId, if not specified.
+ "etag": "A String", # Optional. Needed for resource freshness validation. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
+ "labels": { # Optional. User-defined labels for the Glossary.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the Glossary. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
+ "termCount": 42, # Output only. The number of GlossaryTerms in the Glossary.
+ "uid": "A String", # Output only. System generated unique id for the Glossary. This ID will be different if the Glossary is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the Glossary was last updated.
+ },
+ "updateMask": "A String", # Required. The list of fields to update.
+ "validateOnly": True or False, # Optional. Validates the request without actually updating the Glossary. Default: false.
+ },
+ "updateGlossaryCategory": { # Update GlossaryCategory Request # Payload for updating a GlossaryCategory.
+ "category": { # A GlossaryCategory represents a collection of GlossaryCategories and GlossaryTerms within a Glossary that are related to each other. # Required. The GlossaryCategory to update. The GlossaryCategory's name field is used to identify the GlossaryCategory to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "createTime": "A String", # Output only. The time at which the GlossaryCategory was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryCategory.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryCategory. This is user-mutable. This will be same as the GlossaryCategoryId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryCategory.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryCategory in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryCategory. This ID will be different if the GlossaryCategory is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryCategory was last updated.
+ },
+ "updateMask": "A String", # Required. The list of fields to update.
+ },
+ "updateGlossaryTerm": { # Update GlossaryTerm Request # Payload for updating a GlossaryTerm.
+ "term": { # GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them. # Required. The GlossaryTerm to update. The GlossaryTerm's name field is used to identify the GlossaryTerm to update. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ "createTime": "A String", # Output only. The time at which the GlossaryTerm was created.
+ "description": "A String", # Optional. The user-mutable description of the GlossaryTerm.
+ "displayName": "A String", # Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified.
+ "labels": { # Optional. User-defined labels for the GlossaryTerm.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/terms/{term_id}
+ "parent": "A String", # Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} OR projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}
+ "uid": "A String", # Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name.
+ "updateTime": "A String", # Output only. The time at which the GlossaryTerm was last updated.
+ },
+ "updateMask": "A String", # Required. The list of fields to update.
+ },
+ "updateTime": "A String", # Output only. The time when the ChangeRequest was last updated.
+}
+
+
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.
diff --git a/docs/dyn/dataplex_v1.projects.locations.dataProducts.html b/docs/dyn/dataplex_v1.projects.locations.dataProducts.html
index d60cb02e79..e2d48d7ffd 100644
--- a/docs/dyn/dataplex_v1.projects.locations.dataProducts.html
+++ b/docs/dyn/dataplex_v1.projects.locations.dataProducts.html
@@ -621,6 +621,12 @@ Method Details
"termId": "A String", # Required. GlossaryTerm identifier.
},
"createTime": "A String", # Output only. The time when the ChangeRequest was created.
+ "dataProductAccessRequest": { # Message for requesting access to a Data Product. This will be used to create a ChangeRequest of type REQUEST_DATA_PRODUCT_ACCESS. # Payload for Data Product access request.
+ "accessGroupDisplayName": "A String", # Output only. The display name of the access group defined in the Data Product for which access is being requested.
+ "accessGroupId": "A String", # Required. The ID of the access group for which access is being requested. This corresponds to the unique identifier of the AccessGroup defined in the Data Product.
+ "parent": "A String", # Required. The resource name of the data product. Format: projects/{project_number}/locations/{location_id}/dataProducts/{data_product_id}
+ "requestedPrincipal": "A String", # Optional. The principal for which access is being requested in IAM format. If not specified, the requestor's principal will be used. Example: serviceAccount:my-sa@my-project.iam.gserviceaccount.com. Only service account principals are currently supported. https://cloud.google.com/iam/docs/principal-identifiers
+ },
"deleteEntry": { # Delete Entry request. # Payload for deleting an Entry.
"name": "A String", # Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
},
diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html
index 9963192cae..b8b7c65391 100644
--- a/docs/dyn/dataplex_v1.projects.locations.dataScans.html
+++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.html
@@ -179,7 +179,6 @@ Method Details
"typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean).
},
"unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery.
- "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled.
"semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled.
},
},
@@ -909,7 +908,6 @@ Method Details
"typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean).
},
"unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery.
- "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled.
"semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled.
},
},
@@ -1502,7 +1500,6 @@ Method Details
"typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean).
},
"unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery.
- "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled.
"semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled.
},
},
@@ -2056,7 +2053,6 @@ Method Details
"typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean).
},
"unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery.
- "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled.
"semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled.
},
},
@@ -2628,7 +2624,6 @@ Method Details
"typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean).
},
"unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery.
- "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled.
"semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled.
},
},
diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html
index 6bb99cc2b7..0a5fa0f0b4 100644
--- a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html
+++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html
@@ -306,7 +306,6 @@ Method Details
"typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean).
},
"unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery.
- "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled.
"semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled.
},
},
@@ -817,7 +816,6 @@ Method Details
"typeInferenceDisabled": True or False, # Optional. Whether to disable the inference of data types for JSON data. If true, all columns are registered as their primitive types (strings, number, or boolean).
},
"unstructuredDataOptions": { # Describes options for unstructured data discovery. # Optional. Specifies configuration for unstructured data discovery.
- "entityInferenceEnabled": True or False, # Optional. Deprecated: Use semantic_inference_enabled instead. Specifies whether deeper entity inference over the objects' contents using GenAI is enabled.
"semanticInferenceEnabled": True or False, # Optional. Specifies whether deeper semantic inference over the objects' contents using GenAI is enabled.
},
},
diff --git a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html
index 1f0dc60f51..87ee6fee1e 100644
--- a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html
+++ b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html
@@ -352,6 +352,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -588,6 +599,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -849,6 +871,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1096,6 +1129,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1351,6 +1395,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1588,6 +1643,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
diff --git a/docs/dyn/dialogflow_v2.projects.conversations.html b/docs/dyn/dialogflow_v2.projects.conversations.html
index 42a33bfc4d..2bd8c35b17 100644
--- a/docs/dyn/dialogflow_v2.projects.conversations.html
+++ b/docs/dyn/dialogflow_v2.projects.conversations.html
@@ -345,6 +345,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -631,6 +642,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -916,6 +938,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1207,6 +1240,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1503,6 +1547,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
diff --git a/docs/dyn/dialogflow_v2.projects.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.conversations.participants.html
index 43fa007bbe..1f282603aa 100644
--- a/docs/dyn/dialogflow_v2.projects.conversations.participants.html
+++ b/docs/dyn/dialogflow_v2.projects.conversations.participants.html
@@ -917,6 +917,9 @@ Method Details
"knowledgeAssistAnswer": {
"answerRecord": "A String",
"knowledgeAssistDebugInfo": {
+ "cesDebugInfo": {
+ "a_key": "", # Properties of the object.
+ },
"datastoreResponseReason": "A String",
"ingestedContextReferenceDebugInfo": {
"contextReferenceRetrieved": True or False,
@@ -948,6 +951,11 @@ Method Details
"useTranslatedMessage": True or False,
},
"queryCategorizationFailureReason": "A String",
+ "queryGenerationDebugInfo": {
+ "candidatesTokenCount": 42,
+ "promptTokenCount": 42,
+ "totalTokenCount": 42,
+ },
"queryGenerationFailureReason": "A String",
"serviceLatency": {
"internalServiceLatencies": [
@@ -1198,6 +1206,9 @@ Method Details
"knowledgeAssistAnswer": {
"answerRecord": "A String",
"knowledgeAssistDebugInfo": {
+ "cesDebugInfo": {
+ "a_key": "", # Properties of the object.
+ },
"datastoreResponseReason": "A String",
"ingestedContextReferenceDebugInfo": {
"contextReferenceRetrieved": True or False,
@@ -1229,6 +1240,11 @@ Method Details
"useTranslatedMessage": True or False,
},
"queryCategorizationFailureReason": "A String",
+ "queryGenerationDebugInfo": {
+ "candidatesTokenCount": 42,
+ "promptTokenCount": 42,
+ "totalTokenCount": 42,
+ },
"queryGenerationFailureReason": "A String",
"serviceLatency": {
"internalServiceLatencies": [
diff --git a/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html
index 9e93b15060..521002571a 100644
--- a/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html
+++ b/docs/dyn/dialogflow_v2.projects.conversations.participants.suggestions.html
@@ -215,6 +215,9 @@ Method Details
"knowledgeAssistAnswer": {
"answerRecord": "A String",
"knowledgeAssistDebugInfo": {
+ "cesDebugInfo": {
+ "a_key": "", # Properties of the object.
+ },
"datastoreResponseReason": "A String",
"ingestedContextReferenceDebugInfo": {
"contextReferenceRetrieved": True or False,
@@ -246,6 +249,11 @@ Method Details
"useTranslatedMessage": True or False,
},
"queryCategorizationFailureReason": "A String",
+ "queryGenerationDebugInfo": {
+ "candidatesTokenCount": 42,
+ "promptTokenCount": 42,
+ "totalTokenCount": 42,
+ },
"queryGenerationFailureReason": "A String",
"serviceLatency": {
"internalServiceLatencies": [
diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html
index c4fb802168..c917985466 100644
--- a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html
+++ b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html
@@ -352,6 +352,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -588,6 +599,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -849,6 +871,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1096,6 +1129,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1351,6 +1395,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1588,6 +1643,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.html
index b1cb31273a..2976959761 100644
--- a/docs/dyn/dialogflow_v2.projects.locations.conversations.html
+++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.html
@@ -348,6 +348,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -634,6 +645,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -919,6 +941,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1210,6 +1243,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1560,6 +1604,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html
index dcd6440c44..102420508c 100644
--- a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html
+++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html
@@ -917,6 +917,9 @@ Method Details
"knowledgeAssistAnswer": {
"answerRecord": "A String",
"knowledgeAssistDebugInfo": {
+ "cesDebugInfo": {
+ "a_key": "", # Properties of the object.
+ },
"datastoreResponseReason": "A String",
"ingestedContextReferenceDebugInfo": {
"contextReferenceRetrieved": True or False,
@@ -948,6 +951,11 @@ Method Details
"useTranslatedMessage": True or False,
},
"queryCategorizationFailureReason": "A String",
+ "queryGenerationDebugInfo": {
+ "candidatesTokenCount": 42,
+ "promptTokenCount": 42,
+ "totalTokenCount": 42,
+ },
"queryGenerationFailureReason": "A String",
"serviceLatency": {
"internalServiceLatencies": [
@@ -1198,6 +1206,9 @@ Method Details
"knowledgeAssistAnswer": {
"answerRecord": "A String",
"knowledgeAssistDebugInfo": {
+ "cesDebugInfo": {
+ "a_key": "", # Properties of the object.
+ },
"datastoreResponseReason": "A String",
"ingestedContextReferenceDebugInfo": {
"contextReferenceRetrieved": True or False,
@@ -1229,6 +1240,11 @@ Method Details
"useTranslatedMessage": True or False,
},
"queryCategorizationFailureReason": "A String",
+ "queryGenerationDebugInfo": {
+ "candidatesTokenCount": 42,
+ "promptTokenCount": 42,
+ "totalTokenCount": 42,
+ },
"queryGenerationFailureReason": "A String",
"serviceLatency": {
"internalServiceLatencies": [
diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html
index 722f531892..0c72b151dc 100644
--- a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html
+++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.suggestions.html
@@ -215,6 +215,9 @@ Method Details
"knowledgeAssistAnswer": {
"answerRecord": "A String",
"knowledgeAssistDebugInfo": {
+ "cesDebugInfo": {
+ "a_key": "", # Properties of the object.
+ },
"datastoreResponseReason": "A String",
"ingestedContextReferenceDebugInfo": {
"contextReferenceRetrieved": True or False,
@@ -246,6 +249,11 @@ Method Details
"useTranslatedMessage": True or False,
},
"queryCategorizationFailureReason": "A String",
+ "queryGenerationDebugInfo": {
+ "candidatesTokenCount": 42,
+ "promptTokenCount": 42,
+ "totalTokenCount": 42,
+ },
"queryGenerationFailureReason": "A String",
"serviceLatency": {
"internalServiceLatencies": [
diff --git a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html
index 884533a790..c010ce09d2 100644
--- a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html
+++ b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html
@@ -292,6 +292,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
diff --git a/docs/dyn/dialogflow_v2.projects.suggestions.html b/docs/dyn/dialogflow_v2.projects.suggestions.html
index 3a0dd3250c..c87f0c2b40 100644
--- a/docs/dyn/dialogflow_v2.projects.suggestions.html
+++ b/docs/dyn/dialogflow_v2.projects.suggestions.html
@@ -292,6 +292,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html
index 36366d41ae..d198e8ce9d 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html
@@ -352,6 +352,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -589,6 +600,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -851,6 +873,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1099,6 +1132,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1355,6 +1399,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1593,6 +1648,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.html
index e41b6a46ca..991bcebdb7 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.conversations.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.html
@@ -345,6 +345,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -632,6 +643,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -918,6 +940,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1210,6 +1243,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1507,6 +1551,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html
index b096bfe235..3626a28462 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html
@@ -3232,6 +3232,9 @@ Method Details
"knowledgeAssistAnswer": {
"answerRecord": "A String",
"knowledgeAssistDebugInfo": {
+ "cesDebugInfo": {
+ "a_key": "", # Properties of the object.
+ },
"datastoreResponseReason": "A String",
"ingestedContextReferenceDebugInfo": {
"contextReferenceRetrieved": True or False,
@@ -3263,6 +3266,11 @@ Method Details
"useTranslatedMessage": True or False,
},
"queryCategorizationFailureReason": "A String",
+ "queryGenerationDebugInfo": {
+ "candidatesTokenCount": 42,
+ "promptTokenCount": 42,
+ "totalTokenCount": 42,
+ },
"queryGenerationFailureReason": "A String",
"serviceLatency": {
"internalServiceLatencies": [
@@ -4876,6 +4884,9 @@ Method Details
"knowledgeAssistAnswer": {
"answerRecord": "A String",
"knowledgeAssistDebugInfo": {
+ "cesDebugInfo": {
+ "a_key": "", # Properties of the object.
+ },
"datastoreResponseReason": "A String",
"ingestedContextReferenceDebugInfo": {
"contextReferenceRetrieved": True or False,
@@ -4907,6 +4918,11 @@ Method Details
"useTranslatedMessage": True or False,
},
"queryCategorizationFailureReason": "A String",
+ "queryGenerationDebugInfo": {
+ "candidatesTokenCount": 42,
+ "promptTokenCount": 42,
+ "totalTokenCount": 42,
+ },
"queryGenerationFailureReason": "A String",
"serviceLatency": {
"internalServiceLatencies": [
diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html
index c4c7cba907..119d169ba8 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.suggestions.html
@@ -349,6 +349,9 @@ Method Details
"knowledgeAssistAnswer": {
"answerRecord": "A String",
"knowledgeAssistDebugInfo": {
+ "cesDebugInfo": {
+ "a_key": "", # Properties of the object.
+ },
"datastoreResponseReason": "A String",
"ingestedContextReferenceDebugInfo": {
"contextReferenceRetrieved": True or False,
@@ -380,6 +383,11 @@ Method Details
"useTranslatedMessage": True or False,
},
"queryCategorizationFailureReason": "A String",
+ "queryGenerationDebugInfo": {
+ "candidatesTokenCount": 42,
+ "promptTokenCount": 42,
+ "totalTokenCount": 42,
+ },
"queryGenerationFailureReason": "A String",
"serviceLatency": {
"internalServiceLatencies": [
diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html
index 9a4b9bc54e..93bb6715fd 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html
@@ -352,6 +352,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -589,6 +600,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -851,6 +873,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1099,6 +1132,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1355,6 +1399,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1593,6 +1648,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html
index 0f1ddad56e..349b3948e3 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html
@@ -348,6 +348,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -635,6 +646,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -921,6 +943,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1213,6 +1246,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
@@ -1564,6 +1608,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html
index 3d9b0c436f..76848c7f44 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html
@@ -3232,6 +3232,9 @@ Method Details
"knowledgeAssistAnswer": {
"answerRecord": "A String",
"knowledgeAssistDebugInfo": {
+ "cesDebugInfo": {
+ "a_key": "", # Properties of the object.
+ },
"datastoreResponseReason": "A String",
"ingestedContextReferenceDebugInfo": {
"contextReferenceRetrieved": True or False,
@@ -3263,6 +3266,11 @@ Method Details
"useTranslatedMessage": True or False,
},
"queryCategorizationFailureReason": "A String",
+ "queryGenerationDebugInfo": {
+ "candidatesTokenCount": 42,
+ "promptTokenCount": 42,
+ "totalTokenCount": 42,
+ },
"queryGenerationFailureReason": "A String",
"serviceLatency": {
"internalServiceLatencies": [
@@ -4876,6 +4884,9 @@ Method Details
"knowledgeAssistAnswer": {
"answerRecord": "A String",
"knowledgeAssistDebugInfo": {
+ "cesDebugInfo": {
+ "a_key": "", # Properties of the object.
+ },
"datastoreResponseReason": "A String",
"ingestedContextReferenceDebugInfo": {
"contextReferenceRetrieved": True or False,
@@ -4907,6 +4918,11 @@ Method Details
"useTranslatedMessage": True or False,
},
"queryCategorizationFailureReason": "A String",
+ "queryGenerationDebugInfo": {
+ "candidatesTokenCount": 42,
+ "promptTokenCount": 42,
+ "totalTokenCount": 42,
+ },
"queryGenerationFailureReason": "A String",
"serviceLatency": {
"internalServiceLatencies": [
diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html
index 803f272794..efe01107cf 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.suggestions.html
@@ -214,6 +214,9 @@ Method Details
"knowledgeAssistAnswer": {
"answerRecord": "A String",
"knowledgeAssistDebugInfo": {
+ "cesDebugInfo": {
+ "a_key": "", # Properties of the object.
+ },
"datastoreResponseReason": "A String",
"ingestedContextReferenceDebugInfo": {
"contextReferenceRetrieved": True or False,
@@ -245,6 +248,11 @@ Method Details
"useTranslatedMessage": True or False,
},
"queryCategorizationFailureReason": "A String",
+ "queryGenerationDebugInfo": {
+ "candidatesTokenCount": 42,
+ "promptTokenCount": 42,
+ "totalTokenCount": 42,
+ },
"queryGenerationFailureReason": "A String",
"serviceLatency": {
"internalServiceLatencies": [
diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html
index bed1d493e2..d1a52ea531 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html
@@ -292,6 +292,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
diff --git a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html
index dd709997a9..dc035083b4 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html
@@ -292,6 +292,17 @@ Method Details
"topic": "A String",
},
"securitySettings": "A String",
+ "sipConfig": {
+ "allowVirtualAgentInteraction": True or False,
+ "copyInboundCallLegHeaders": [
+ "A String",
+ ],
+ "createConversationOnTheFly": True or False,
+ "ignoreReinviteMediaDirection": True or False,
+ "inactiveStart": True or False,
+ "keepConversationRunning": True or False,
+ "maxAudioRecordingDuration": "A String",
+ },
"sttConfig": {
"audioEncoding": "A String",
"enableWordInfo": True or False,
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html
index 7cef2261ed..d658a83ae4 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html
@@ -380,7 +380,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -625,7 +625,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -826,7 +826,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -1015,7 +1015,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -1186,7 +1186,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
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 2a65c7a645..cd96c68ab0 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html
@@ -1771,7 +1771,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score.
"returnRelevanceScore": True or False, # Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.
@@ -2240,7 +2240,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score.
"returnRelevanceScore": True or False, # Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html
index 6a386658b2..cf49e94d54 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html
@@ -665,6 +665,12 @@ Method Details
"invocationTools": [ # The tool names of the tools that were invoked.
"A String",
],
+ "invokedSkills": [ # The skills executed during the turn.
+ { # Represents a skill used during the assist call.
+ "displayName": "A String", # The display name of the skill.
+ "name": "A String", # The resource name of the skill.
+ },
+ ],
"sessionInfo": { # Information about the session. # Session information. Only included in the final StreamAssistResponse of the response stream.
"session": "A String", # Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`.
},
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 98883fce20..8ffaecf2f7 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html
@@ -1771,7 +1771,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score.
"returnRelevanceScore": True or False, # Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.
@@ -2240,7 +2240,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score.
"returnRelevanceScore": True or False, # Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html
index 8977ac4a3e..be00561cb9 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html
@@ -372,7 +372,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -617,7 +617,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -818,7 +818,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -1007,7 +1007,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -1178,7 +1178,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html
index 9efedadac6..33c72895cb 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html
@@ -1771,7 +1771,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score.
"returnRelevanceScore": True or False, # Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.
@@ -2240,7 +2240,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"relevanceScoreSpec": { # The specification for returning the document relevance score. # Optional. The specification for returning the relevance score.
"returnRelevanceScore": True or False, # Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html
index 0979c69a6f..8393c4fcdf 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html
@@ -470,7 +470,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -481,7 +481,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -795,7 +795,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -806,7 +806,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -1117,7 +1117,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -1128,7 +1128,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -1344,7 +1344,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -1355,7 +1355,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -1553,7 +1553,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -1564,7 +1564,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.html
index 3484fa59ae..e9fc107d8e 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.schemas.html
@@ -133,7 +133,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -241,7 +241,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -290,7 +290,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -345,7 +345,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
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 ccd9735e1f..9642a3ab84 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html
@@ -2005,7 +2005,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
"relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
@@ -2672,7 +2672,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
"relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html
index 766e643d99..cba2c0de08 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html
@@ -713,6 +713,12 @@ Method Details
"invocationTools": [ # The tool names of the tools that were invoked.
"A String",
],
+ "invokedSkills": [ # The skills executed during the turn.
+ { # Represents a skill used during the assist call.
+ "displayName": "A String", # The display name of the skill.
+ "name": "A String", # The resource name of the skill.
+ },
+ ],
"sessionInfo": { # Information about the session. # Session information. Only included in the final StreamAssistResponse of the response stream.
"session": "A String", # Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`.
},
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 0248c7dfe3..df17bc5357 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html
@@ -2005,7 +2005,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
"relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
@@ -2672,7 +2672,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
"relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html
index 253deadaa9..0db4064b33 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html
@@ -312,7 +312,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -574,7 +574,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -840,7 +840,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -1116,7 +1116,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -1402,7 +1402,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -1655,7 +1655,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html
index e24820a542..403daef685 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html
@@ -462,7 +462,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -473,7 +473,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -787,7 +787,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -798,7 +798,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -1109,7 +1109,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -1120,7 +1120,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -1336,7 +1336,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -1347,7 +1347,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -1545,7 +1545,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -1556,7 +1556,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.schemas.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.schemas.html
index 438c24c273..2be6571b80 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.schemas.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.schemas.html
@@ -128,7 +128,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -236,7 +236,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -285,7 +285,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -340,7 +340,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html
index 82c5948ab3..d96c9c923e 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html
@@ -2005,7 +2005,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
"relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
@@ -2672,7 +2672,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
"relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html
index ca8d59500d..d320263a7e 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html
@@ -324,7 +324,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
"relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
@@ -666,7 +666,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
"relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
@@ -984,7 +984,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
"relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html
index a49d7bac1f..17b84f0ce0 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html
@@ -228,10 +228,11 @@ Method Details
"externalId": "A String", # The unique 3P ID(external_id) of the entity (user or group).
"groupMetadata": { # Metadata corresponding to the external group. # Metadata corresponding to the external user.
},
+ "subject": "A String", # Output only. Represents the canonical IAM subject identifier (for users) or group identifier (for groups), derived from the workforce-pool claim mapping. Falls back to custom logic if not set. This must be used for IAM bindings.
"userMetadata": { # Metadata corresponding to the external user. # Metadata corresponding to the external user.
"familyName": "A String", # The user's family name.
"givenName": "A String", # The user's given name.
- "primaryEmail": "A String", # The user's primary email address.
+ "primaryEmail": "A String", # The user's primary email address. Do not use this for IAM bindings. Use ExternalIdentity.subject.
},
},
],
@@ -1179,7 +1180,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
@@ -1462,7 +1463,7 @@ Method Details
"schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
"A String",
],
- "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.
+ "searchableFieldImportance": "A String", # Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`. For more information, see [Weight searchable fields](https://cloud.google.com/generative-ai-app-builder/docs/configure-field-settings#weight-search).
"searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
},
],
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html
index 4f74868d3f..3d66e459e5 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html
@@ -381,7 +381,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -632,7 +632,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -839,7 +839,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -1034,7 +1034,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -1211,7 +1211,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
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 1f4589cce1..556f562cdd 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html
@@ -1884,7 +1884,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
"relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
@@ -2547,7 +2547,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
"relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html
index a60a6413f4..f4993e6d10 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html
@@ -665,6 +665,12 @@ Method Details
"invocationTools": [ # The tool names of the tools that were invoked.
"A String",
],
+ "invokedSkills": [ # The skills executed during the turn.
+ { # Represents a skill used during the assist call.
+ "displayName": "A String", # The display name of the skill.
+ "name": "A String", # The resource name of the skill.
+ },
+ ],
"sessionInfo": { # Information about the session. # Session information. Only included in the final StreamAssistResponse of the response stream.
"session": "A String", # Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`.
},
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 9aabe6e08c..f9375d9889 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html
@@ -1884,7 +1884,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
"relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
@@ -2547,7 +2547,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
"relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html
index a29c57cab5..ef91643faa 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html
@@ -373,7 +373,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -624,7 +624,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -831,7 +831,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -1026,7 +1026,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
@@ -1203,7 +1203,7 @@ Method Details
},
},
"workspaceConfig": { # Config to store data store type configuration for workspace data # Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
- "dasherCustomerId": "A String", # Obfuscated Dasher customer ID.
+ "dasherCustomerId": "A String", # Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored.
"superAdminEmailAddress": "A String", # Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"superAdminServiceAccount": "A String", # Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.
"type": "A String", # The Google Workspace data source.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html
index df191921b2..8101c88394 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html
@@ -1884,7 +1884,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
"relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
@@ -2547,7 +2547,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
"relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html
index c194bff6dd..2f278953bf 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html
@@ -321,7 +321,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
"relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
@@ -659,7 +659,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
"relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
@@ -973,7 +973,7 @@ Method Details
"condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
"pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
},
- "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result
+ "rankingExpression": "A String", # Optional. The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the `ranking_expression_backend` value. If `ranking_expression_backend` is not provided, it defaults to `RANK_BY_EMBEDDING`. If ranking_expression_backend is not provided or set to `RANK_BY_EMBEDDING`, it should be a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between `embedding_field_path` and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. If ranking_expression_backend is set to `RANK_BY_FORMULA`, the following expression types (and combinations of those chained using + or * operators) are supported: * `double` * `signal` * `log(signal)` * `exp(signal)` * `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant. * `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise. * `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 | double, else returns signal1. Here are a few examples of ranking formulas that use the supported ranking expression types: - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment. - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 * is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN. - `0.2 * rr(semantic_similarity_score, 16) + 0.8 * rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`. The following signals are supported: * `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document. * `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query. * `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents. * `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking. * `freshness_rank`: freshness adjustment as a rank * `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes). * `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document. * `base_rank`: the default rank of the result * `media_actor_match`: whether the media actor matches the query * `media_director_match`: whether the media director matches the query * `media_genre_match`: whether the media genre matches the query * `media_language_match`: whether the media language matches the query * `media_title_match`: whether the media title matches the query * `media_prefix_similarity_rank`: prefix similarity rank for media results * `media_semantic_similarity_rank`: semantic similarity rank for media results
"rankingExpressionBackend": "A String", # Optional. The backend to use for the ranking expression evaluation.
"regionCode": "A String", # The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
"relevanceFilterSpec": { # Relevance filtering specification. # Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
diff --git a/docs/dyn/dlp_v2.organizations.inspectTemplates.html b/docs/dyn/dlp_v2.organizations.inspectTemplates.html
index 86824cb97b..5195a2b5c9 100644
--- a/docs/dyn/dlp_v2.organizations.inspectTemplates.html
+++ b/docs/dyn/dlp_v2.organizations.inspectTemplates.html
@@ -112,7 +112,7 @@ Method Details
{ # Request message for CreateInspectTemplate.
"inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The InspectTemplate to create.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -372,7 +372,7 @@ Method Details
An object of the form:
{ # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -654,7 +654,7 @@ Method Details
An object of the form:
{ # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -924,7 +924,7 @@ Method Details
{ # Response message for ListInspectTemplates.
"inspectTemplates": [ # List of inspectTemplates, up to page_size in ListInspectTemplatesRequest.
{ # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -1201,7 +1201,7 @@ Method Details
{ # Request message for UpdateInspectTemplate.
"inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New InspectTemplate value.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -1460,7 +1460,7 @@ Method Details
An object of the form:
{ # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
diff --git a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html
index e9170727dc..548f7b6b66 100644
--- a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html
+++ b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html
@@ -3109,7 +3109,7 @@ Method Details
},
},
"snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
diff --git a/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html b/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html
index 73fa4a7bb7..0399db6787 100644
--- a/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html
+++ b/docs/dyn/dlp_v2.organizations.locations.inspectTemplates.html
@@ -112,7 +112,7 @@ Method Details
{ # Request message for CreateInspectTemplate.
"inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The InspectTemplate to create.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -372,7 +372,7 @@ Method Details
An object of the form:
{ # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -654,7 +654,7 @@ Method Details
An object of the form:
{ # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -924,7 +924,7 @@ Method Details
{ # Response message for ListInspectTemplates.
"inspectTemplates": [ # List of inspectTemplates, up to page_size in ListInspectTemplatesRequest.
{ # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -1201,7 +1201,7 @@ Method Details
{ # Request message for UpdateInspectTemplate.
"inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New InspectTemplate value.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -1460,7 +1460,7 @@ Method Details
An object of the form:
{ # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
diff --git a/docs/dyn/dlp_v2.projects.content.html b/docs/dyn/dlp_v2.projects.content.html
index 28394d1f3b..d62bc1196c 100644
--- a/docs/dyn/dlp_v2.projects.content.html
+++ b/docs/dyn/dlp_v2.projects.content.html
@@ -1212,6 +1212,15 @@ Method Details
},
],
},
+ "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order.
+ "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response.
+ { # Single message in a conversation.
+ "content": "A String", # The contents of this message.
+ "messageType": "A String", # The type of message.
+ "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters.
+ },
+ ],
+ },
"table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more.
"headers": [ # Headers of the table.
{ # General identifier of a data field in a storage service.
@@ -1271,6 +1280,15 @@ Method Details
},
],
},
+ "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order.
+ "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response.
+ { # Single message in a conversation.
+ "content": "A String", # The contents of this message.
+ "messageType": "A String", # The type of message.
+ "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters.
+ },
+ ],
+ },
"table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more.
"headers": [ # Headers of the table.
{ # General identifier of a data field in a storage service.
@@ -2399,6 +2417,15 @@ Method Details
},
],
},
+ "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order.
+ "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response.
+ { # Single message in a conversation.
+ "content": "A String", # The contents of this message.
+ "messageType": "A String", # The type of message.
+ "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters.
+ },
+ ],
+ },
"table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more.
"headers": [ # Headers of the table.
{ # General identifier of a data field in a storage service.
@@ -2486,6 +2513,11 @@ Method Details
"containerName": "A String", # Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows: * BigQuery tables: `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested names could be absent if the embedded object has no string identifier (for example, an image contained within a document).
"containerTimestamp": "A String", # Finding container modification timestamp, if applicable. For Cloud Storage, this field contains the last file modification timestamp. For a BigQuery table, this field contains the last_modified_time property. For Datastore, this field isn't populated.
"containerVersion": "A String", # Finding container version, if available ("generation" for Cloud Storage).
+ "conversationLocation": { # Location within a conversation. # Location within a conversation.
+ "allMessages": { # If set, indicates that the finding applies to all messages in the conversation. # If set, indicates that the finding applies to all messages in the conversation.
+ },
+ "messageIndex": 42, # Matches an index of a message in the conversation provided in the request.
+ },
"documentLocation": { # Location of a finding within a document. # Location data for document files.
"fileOffset": "A String", # Offset of the line, from the beginning of the file, where the finding is located.
},
@@ -2841,6 +2873,15 @@ Method Details
},
],
},
+ "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order.
+ "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response.
+ { # Single message in a conversation.
+ "content": "A String", # The contents of this message.
+ "messageType": "A String", # The type of message.
+ "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters.
+ },
+ ],
+ },
"table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more.
"headers": [ # Headers of the table.
{ # General identifier of a data field in a storage service.
@@ -3756,6 +3797,15 @@ Method Details
},
],
},
+ "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order.
+ "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response.
+ { # Single message in a conversation.
+ "content": "A String", # The contents of this message.
+ "messageType": "A String", # The type of message.
+ "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters.
+ },
+ ],
+ },
"table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more.
"headers": [ # Headers of the table.
{ # General identifier of a data field in a storage service.
diff --git a/docs/dyn/dlp_v2.projects.dlpJobs.html b/docs/dyn/dlp_v2.projects.dlpJobs.html
index 0f9691975d..b63e93ecb4 100644
--- a/docs/dyn/dlp_v2.projects.dlpJobs.html
+++ b/docs/dyn/dlp_v2.projects.dlpJobs.html
@@ -3682,7 +3682,7 @@ Method Details
},
},
"snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -7544,7 +7544,7 @@ Method Details
},
},
"snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -11400,7 +11400,7 @@ Method Details
},
},
"snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
diff --git a/docs/dyn/dlp_v2.projects.image.html b/docs/dyn/dlp_v2.projects.image.html
index a51951e574..c64b4ad838 100644
--- a/docs/dyn/dlp_v2.projects.image.html
+++ b/docs/dyn/dlp_v2.projects.image.html
@@ -414,6 +414,11 @@ Method Details
"containerName": "A String", # Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows: * BigQuery tables: `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested names could be absent if the embedded object has no string identifier (for example, an image contained within a document).
"containerTimestamp": "A String", # Finding container modification timestamp, if applicable. For Cloud Storage, this field contains the last file modification timestamp. For a BigQuery table, this field contains the last_modified_time property. For Datastore, this field isn't populated.
"containerVersion": "A String", # Finding container version, if available ("generation" for Cloud Storage).
+ "conversationLocation": { # Location within a conversation. # Location within a conversation.
+ "allMessages": { # If set, indicates that the finding applies to all messages in the conversation. # If set, indicates that the finding applies to all messages in the conversation.
+ },
+ "messageIndex": 42, # Matches an index of a message in the conversation provided in the request.
+ },
"documentLocation": { # Location of a finding within a document. # Location data for document files.
"fileOffset": "A String", # Offset of the line, from the beginning of the file, where the finding is located.
},
diff --git a/docs/dyn/dlp_v2.projects.inspectTemplates.html b/docs/dyn/dlp_v2.projects.inspectTemplates.html
index 9f89db71fc..6bfe934c4a 100644
--- a/docs/dyn/dlp_v2.projects.inspectTemplates.html
+++ b/docs/dyn/dlp_v2.projects.inspectTemplates.html
@@ -112,7 +112,7 @@ Method Details
{ # Request message for CreateInspectTemplate.
"inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The InspectTemplate to create.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -372,7 +372,7 @@ Method Details
An object of the form:
{ # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -654,7 +654,7 @@ Method Details
An object of the form:
{ # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -924,7 +924,7 @@ Method Details
{ # Response message for ListInspectTemplates.
"inspectTemplates": [ # List of inspectTemplates, up to page_size in ListInspectTemplatesRequest.
{ # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -1201,7 +1201,7 @@ Method Details
{ # Request message for UpdateInspectTemplate.
"inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New InspectTemplate value.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -1460,7 +1460,7 @@ Method Details
An object of the form:
{ # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
diff --git a/docs/dyn/dlp_v2.projects.jobTriggers.html b/docs/dyn/dlp_v2.projects.jobTriggers.html
index f79f723ae6..b48b106fbc 100644
--- a/docs/dyn/dlp_v2.projects.jobTriggers.html
+++ b/docs/dyn/dlp_v2.projects.jobTriggers.html
@@ -3113,7 +3113,7 @@ Method Details
},
},
"snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
diff --git a/docs/dyn/dlp_v2.projects.locations.content.html b/docs/dyn/dlp_v2.projects.locations.content.html
index 965afc3d2d..74d2ddaf7c 100644
--- a/docs/dyn/dlp_v2.projects.locations.content.html
+++ b/docs/dyn/dlp_v2.projects.locations.content.html
@@ -1212,6 +1212,15 @@ Method Details
},
],
},
+ "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order.
+ "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response.
+ { # Single message in a conversation.
+ "content": "A String", # The contents of this message.
+ "messageType": "A String", # The type of message.
+ "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters.
+ },
+ ],
+ },
"table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more.
"headers": [ # Headers of the table.
{ # General identifier of a data field in a storage service.
@@ -1271,6 +1280,15 @@ Method Details
},
],
},
+ "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order.
+ "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response.
+ { # Single message in a conversation.
+ "content": "A String", # The contents of this message.
+ "messageType": "A String", # The type of message.
+ "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters.
+ },
+ ],
+ },
"table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more.
"headers": [ # Headers of the table.
{ # General identifier of a data field in a storage service.
@@ -2399,6 +2417,15 @@ Method Details
},
],
},
+ "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order.
+ "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response.
+ { # Single message in a conversation.
+ "content": "A String", # The contents of this message.
+ "messageType": "A String", # The type of message.
+ "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters.
+ },
+ ],
+ },
"table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more.
"headers": [ # Headers of the table.
{ # General identifier of a data field in a storage service.
@@ -2486,6 +2513,11 @@ Method Details
"containerName": "A String", # Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows: * BigQuery tables: `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested names could be absent if the embedded object has no string identifier (for example, an image contained within a document).
"containerTimestamp": "A String", # Finding container modification timestamp, if applicable. For Cloud Storage, this field contains the last file modification timestamp. For a BigQuery table, this field contains the last_modified_time property. For Datastore, this field isn't populated.
"containerVersion": "A String", # Finding container version, if available ("generation" for Cloud Storage).
+ "conversationLocation": { # Location within a conversation. # Location within a conversation.
+ "allMessages": { # If set, indicates that the finding applies to all messages in the conversation. # If set, indicates that the finding applies to all messages in the conversation.
+ },
+ "messageIndex": 42, # Matches an index of a message in the conversation provided in the request.
+ },
"documentLocation": { # Location of a finding within a document. # Location data for document files.
"fileOffset": "A String", # Offset of the line, from the beginning of the file, where the finding is located.
},
@@ -2841,6 +2873,15 @@ Method Details
},
],
},
+ "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order.
+ "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response.
+ { # Single message in a conversation.
+ "content": "A String", # The contents of this message.
+ "messageType": "A String", # The type of message.
+ "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters.
+ },
+ ],
+ },
"table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more.
"headers": [ # Headers of the table.
{ # General identifier of a data field in a storage service.
@@ -3756,6 +3797,15 @@ Method Details
},
],
},
+ "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order.
+ "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response.
+ { # Single message in a conversation.
+ "content": "A String", # The contents of this message.
+ "messageType": "A String", # The type of message.
+ "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters.
+ },
+ ],
+ },
"table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more.
"headers": [ # Headers of the table.
{ # General identifier of a data field in a storage service.
diff --git a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html
index 99ec71825c..ab8c2a6381 100644
--- a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html
+++ b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html
@@ -3688,7 +3688,7 @@ Method Details
},
},
"snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -7574,7 +7574,7 @@ Method Details
},
},
"snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -8457,6 +8457,15 @@ Method Details
},
],
},
+ "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order.
+ "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response.
+ { # Single message in a conversation.
+ "content": "A String", # The contents of this message.
+ "messageType": "A String", # The type of message.
+ "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters.
+ },
+ ],
+ },
"table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more.
"headers": [ # Headers of the table.
{ # General identifier of a data field in a storage service.
@@ -11526,7 +11535,7 @@ Method Details
},
},
"snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
diff --git a/docs/dyn/dlp_v2.projects.locations.image.html b/docs/dyn/dlp_v2.projects.locations.image.html
index 982305be15..cca91c0f74 100644
--- a/docs/dyn/dlp_v2.projects.locations.image.html
+++ b/docs/dyn/dlp_v2.projects.locations.image.html
@@ -414,6 +414,11 @@ Method Details
"containerName": "A String", # Name of the container where the finding is located. The top level name is the source file name or table name. Names of some common storage containers are formatted as follows: * BigQuery tables: `{project_id}:{dataset_id}.{table_id}` * Cloud Storage files: `gs://{bucket}/{path}` * Datastore namespace: {namespace} Nested names could be absent if the embedded object has no string identifier (for example, an image contained within a document).
"containerTimestamp": "A String", # Finding container modification timestamp, if applicable. For Cloud Storage, this field contains the last file modification timestamp. For a BigQuery table, this field contains the last_modified_time property. For Datastore, this field isn't populated.
"containerVersion": "A String", # Finding container version, if available ("generation" for Cloud Storage).
+ "conversationLocation": { # Location within a conversation. # Location within a conversation.
+ "allMessages": { # If set, indicates that the finding applies to all messages in the conversation. # If set, indicates that the finding applies to all messages in the conversation.
+ },
+ "messageIndex": 42, # Matches an index of a message in the conversation provided in the request.
+ },
"documentLocation": { # Location of a finding within a document. # Location data for document files.
"fileOffset": "A String", # Offset of the line, from the beginning of the file, where the finding is located.
},
diff --git a/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html b/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html
index a1936fe8b6..a296f15e5d 100644
--- a/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html
+++ b/docs/dyn/dlp_v2.projects.locations.inspectTemplates.html
@@ -112,7 +112,7 @@ Method Details
{ # Request message for CreateInspectTemplate.
"inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # Required. The InspectTemplate to create.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -372,7 +372,7 @@ Method Details
An object of the form:
{ # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -654,7 +654,7 @@ Method Details
An object of the form:
{ # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -924,7 +924,7 @@ Method Details
{ # Response message for ListInspectTemplates.
"inspectTemplates": [ # List of inspectTemplates, up to page_size in ListInspectTemplatesRequest.
{ # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -1201,7 +1201,7 @@ Method Details
{ # Request message for UpdateInspectTemplate.
"inspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # New InspectTemplate value.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -1460,7 +1460,7 @@ Method Details
An object of the form:
{ # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
diff --git a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html
index fbcaf047c7..7cf85be34b 100644
--- a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html
+++ b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html
@@ -3116,7 +3116,7 @@ Method Details
},
},
"snapshotInspectTemplate": { # The inspectTemplate contains a configuration (set of types of sensitive data to be detected) to be used anywhere you otherwise would normally specify InspectConfig. See https://cloud.google.com/sensitive-data-protection/docs/concepts-templates to learn more. # If run with an InspectTemplate, a snapshot of its state at the time of this run.
- "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of limited-availability built-in infoTypes in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere. For more information, see https://cloud.google.com/sensitive-data-protection/docs/locations#location-specific_limitations to learn more about location-specific limitations.
+ "allowLimitedAvailabilityInfoTypes": True or False, # Optional. Enables the use of [limited-availability built-in infoTypes](https://docs.cloud.google.com/sensitive-data-protection/docs/infotypes-reference#limited-availability-infotypes) in inspect_config. These infoTypes are supported only in specific regions and can cause scanning errors if used elsewhere.
"createTime": "A String", # Output only. The creation timestamp of an inspectTemplate.
"description": "A String", # Short description (max 256 chars).
"displayName": "A String", # Display name (max 256 chars).
@@ -5283,6 +5283,15 @@ Method Details
},
],
},
+ "conversation": { # Complete conversation or slice of a conversation. It is assumed that all included messages are contiguous and ordered in chronological order. # Represents a conversation (either complete or a slice). It is assumed that all included messages are contiguous and ordered in chronological order.
+ "messages": [ # Messages exchanged within this conversation. The maximum number of messages allowed is 50k. The order of the messages is assumed to be chronological and will be used to index findings in the response.
+ { # Single message in a conversation.
+ "content": "A String", # The contents of this message.
+ "messageType": "A String", # The type of message.
+ "participantId": "A String", # Optional. The identifier of the participant. For example 'test-user' or 'gemini'. The participant ID can contain lowercase letters, numbers, and hyphens; that is, it must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`. The maximum length is 63 characters.
+ },
+ ],
+ },
"table": { # Structured content to inspect. Up to 50,000 `Value`s per request allowed. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-structured-text#inspecting_a_table to learn more. # Structured content for inspection. See https://cloud.google.com/sensitive-data-protection/docs/inspecting-text#inspecting_a_table to learn more.
"headers": [ # Headers of the table.
{ # General identifier of a data field in a storage service.
diff --git a/docs/dyn/firebaseapphosting_v1.projects.locations.backends.traffic.html b/docs/dyn/firebaseapphosting_v1.projects.locations.backends.traffic.html
index 6f4b451f90..c71b4be6f8 100644
--- a/docs/dyn/firebaseapphosting_v1.projects.locations.backends.traffic.html
+++ b/docs/dyn/firebaseapphosting_v1.projects.locations.backends.traffic.html
@@ -126,13 +126,13 @@ Method Details
"codebaseBranch": "A String", # If set, specifies a branch that triggers a new build to be started with this policy. Otherwise, no automatic rollouts will happen.
"disabled": True or False, # Optional. A flag that, if true, prevents automatic rollouts from being created via this RolloutPolicy.
"disabledTime": "A String", # Output only. If `disabled` is set, the time at which the automatic rollouts were disabled.
- "ignoredPaths": [ # Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ignored_paths: { pattern: "foo/bar/excluded/*” type: GLOB }
+ "ignoredPaths": [ # Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ``` ignored_paths: { pattern: "foo/bar/excluded/*", type: "GLOB" } ```
{ # A file path pattern to match against.
"pattern": "A String", # Optional. The pattern to match against.
"type": "A String", # Optional. The type of pattern to match against.
},
],
- "requiredPaths": [ # Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: “required_paths: { pattern: "foo/bar/*” type: GLOB }
+ "requiredPaths": [ # Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: ``` required_paths: { pattern: "foo/bar/*", type: "GLOB" } ```
{ # A file path pattern to match against.
"pattern": "A String", # Optional. The pattern to match against.
"type": "A String", # Optional. The type of pattern to match against.
@@ -184,13 +184,13 @@ Method Details
"codebaseBranch": "A String", # If set, specifies a branch that triggers a new build to be started with this policy. Otherwise, no automatic rollouts will happen.
"disabled": True or False, # Optional. A flag that, if true, prevents automatic rollouts from being created via this RolloutPolicy.
"disabledTime": "A String", # Output only. If `disabled` is set, the time at which the automatic rollouts were disabled.
- "ignoredPaths": [ # Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ignored_paths: { pattern: "foo/bar/excluded/*” type: GLOB }
+ "ignoredPaths": [ # Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ``` ignored_paths: { pattern: "foo/bar/excluded/*", type: "GLOB" } ```
{ # A file path pattern to match against.
"pattern": "A String", # Optional. The pattern to match against.
"type": "A String", # Optional. The type of pattern to match against.
},
],
- "requiredPaths": [ # Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: “required_paths: { pattern: "foo/bar/*” type: GLOB }
+ "requiredPaths": [ # Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: ``` required_paths: { pattern: "foo/bar/*", type: "GLOB" } ```
{ # A file path pattern to match against.
"pattern": "A String", # Optional. The pattern to match against.
"type": "A String", # Optional. The type of pattern to match against.
diff --git a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html
index e1aeba1802..efc5165513 100644
--- a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html
+++ b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html
@@ -135,6 +135,7 @@ Method Details
"a_key": "A String",
},
"appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend.
+ "automaticBaseImageUpdatesDisabled": True or False, # Optional. automatic_base_image_updates_disabled acts as a way for users to opt out of ABIU.
"codebase": { # The connection to an external source repository to watch for event-driven updates to the backend. # Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend.
"repository": "A String", # Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console.
"rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file.
@@ -170,6 +171,9 @@ Method Details
],
"reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO.
"requestLogsDisabled": True or False, # Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default.
+ "runtime": { # Runtime is a string that represents the runtime that is used to build the backend. Users can specify one of the following runtimes: nodejs20, nodejs22, nodejs24, nodejs. Runtime "nodejs" means that nodejs version will be determined at build time. If not specified or specified with a value that is not in the list above, the default runtime `nodejs` will be used and Automatic Base Image Updates will be disabled. # Optional. The runtime that the backend will be built on. A default base_image will be chosen for a given runtime.
+ "value": "A String", # Optional. The value of the runtime.
+ },
"serviceAccount": "A String", # Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions.
"servingLocality": "A String", # Required. Immutable. Specifies how App Hosting will serve the content for this backend. It will either be contained to a single region (REGIONAL_STRICT) or allowed to use App Hosting's global-replicated serving infrastructure (GLOBAL_ACCESS).
"uid": "A String", # Output only. System-assigned, unique identifier.
@@ -267,6 +271,7 @@ Method Details
"a_key": "A String",
},
"appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend.
+ "automaticBaseImageUpdatesDisabled": True or False, # Optional. automatic_base_image_updates_disabled acts as a way for users to opt out of ABIU.
"codebase": { # The connection to an external source repository to watch for event-driven updates to the backend. # Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend.
"repository": "A String", # Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console.
"rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file.
@@ -302,6 +307,9 @@ Method Details
],
"reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO.
"requestLogsDisabled": True or False, # Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default.
+ "runtime": { # Runtime is a string that represents the runtime that is used to build the backend. Users can specify one of the following runtimes: nodejs20, nodejs22, nodejs24, nodejs. Runtime "nodejs" means that nodejs version will be determined at build time. If not specified or specified with a value that is not in the list above, the default runtime `nodejs` will be used and Automatic Base Image Updates will be disabled. # Optional. The runtime that the backend will be built on. A default base_image will be chosen for a given runtime.
+ "value": "A String", # Optional. The value of the runtime.
+ },
"serviceAccount": "A String", # Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions.
"servingLocality": "A String", # Required. Immutable. Specifies how App Hosting will serve the content for this backend. It will either be contained to a single region (REGIONAL_STRICT) or allowed to use App Hosting's global-replicated serving infrastructure (GLOBAL_ACCESS).
"uid": "A String", # Output only. System-assigned, unique identifier.
@@ -336,6 +344,7 @@ Method Details
"a_key": "A String",
},
"appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend.
+ "automaticBaseImageUpdatesDisabled": True or False, # Optional. automatic_base_image_updates_disabled acts as a way for users to opt out of ABIU.
"codebase": { # The connection to an external source repository to watch for event-driven updates to the backend. # Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend.
"repository": "A String", # Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console.
"rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file.
@@ -371,6 +380,9 @@ Method Details
],
"reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO.
"requestLogsDisabled": True or False, # Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default.
+ "runtime": { # Runtime is a string that represents the runtime that is used to build the backend. Users can specify one of the following runtimes: nodejs20, nodejs22, nodejs24, nodejs. Runtime "nodejs" means that nodejs version will be determined at build time. If not specified or specified with a value that is not in the list above, the default runtime `nodejs` will be used and Automatic Base Image Updates will be disabled. # Optional. The runtime that the backend will be built on. A default base_image will be chosen for a given runtime.
+ "value": "A String", # Optional. The value of the runtime.
+ },
"serviceAccount": "A String", # Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions.
"servingLocality": "A String", # Required. Immutable. Specifies how App Hosting will serve the content for this backend. It will either be contained to a single region (REGIONAL_STRICT) or allowed to use App Hosting's global-replicated serving infrastructure (GLOBAL_ACCESS).
"uid": "A String", # Output only. System-assigned, unique identifier.
@@ -413,6 +425,7 @@ Method Details
"a_key": "A String",
},
"appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend.
+ "automaticBaseImageUpdatesDisabled": True or False, # Optional. automatic_base_image_updates_disabled acts as a way for users to opt out of ABIU.
"codebase": { # The connection to an external source repository to watch for event-driven updates to the backend. # Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend.
"repository": "A String", # Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console.
"rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file.
@@ -448,6 +461,9 @@ Method Details
],
"reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO.
"requestLogsDisabled": True or False, # Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default.
+ "runtime": { # Runtime is a string that represents the runtime that is used to build the backend. Users can specify one of the following runtimes: nodejs20, nodejs22, nodejs24, nodejs. Runtime "nodejs" means that nodejs version will be determined at build time. If not specified or specified with a value that is not in the list above, the default runtime `nodejs` will be used and Automatic Base Image Updates will be disabled. # Optional. The runtime that the backend will be built on. A default base_image will be chosen for a given runtime.
+ "value": "A String", # Optional. The value of the runtime.
+ },
"serviceAccount": "A String", # Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions.
"servingLocality": "A String", # Required. Immutable. Specifies how App Hosting will serve the content for this backend. It will either be contained to a single region (REGIONAL_STRICT) or allowed to use App Hosting's global-replicated serving infrastructure (GLOBAL_ACCESS).
"uid": "A String", # Output only. System-assigned, unique identifier.
diff --git a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.traffic.html b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.traffic.html
index ffa801ec48..69f00b3eb5 100644
--- a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.traffic.html
+++ b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.traffic.html
@@ -126,13 +126,13 @@ Method Details
"codebaseBranch": "A String", # If set, specifies a branch that triggers a new build to be started with this policy. Otherwise, no automatic rollouts will happen.
"disabled": True or False, # Optional. A flag that, if true, prevents automatic rollouts from being created via this RolloutPolicy.
"disabledTime": "A String", # Output only. If `disabled` is set, the time at which the automatic rollouts were disabled.
- "ignoredPaths": [ # Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ignored_paths: { pattern: "foo/bar/excluded/*” type: GLOB }
+ "ignoredPaths": [ # Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ``` ignored_paths: { pattern: "foo/bar/excluded/*", type: "GLOB" } ```
{ # A file path pattern to match against.
"pattern": "A String", # Optional. The pattern to match against.
"type": "A String", # Optional. The type of pattern to match against.
},
],
- "requiredPaths": [ # Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: “required_paths: { pattern: "foo/bar/*” type: GLOB }
+ "requiredPaths": [ # Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: ``` required_paths: { pattern: "foo/bar/*", type: "GLOB" } ```
{ # A file path pattern to match against.
"pattern": "A String", # Optional. The pattern to match against.
"type": "A String", # Optional. The type of pattern to match against.
@@ -184,13 +184,13 @@ Method Details
"codebaseBranch": "A String", # If set, specifies a branch that triggers a new build to be started with this policy. Otherwise, no automatic rollouts will happen.
"disabled": True or False, # Optional. A flag that, if true, prevents automatic rollouts from being created via this RolloutPolicy.
"disabledTime": "A String", # Output only. If `disabled` is set, the time at which the automatic rollouts were disabled.
- "ignoredPaths": [ # Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ignored_paths: { pattern: "foo/bar/excluded/*” type: GLOB }
+ "ignoredPaths": [ # Optional. A list of file paths patterns to exclude from triggering a rollout. Patterns in this list take precedence over required_paths. **Note**: All paths must be in the ignored_paths in order for the rollout to be skipped. Limited to 100 paths. Example: ``` ignored_paths: { pattern: "foo/bar/excluded/*", type: "GLOB" } ```
{ # A file path pattern to match against.
"pattern": "A String", # Optional. The pattern to match against.
"type": "A String", # Optional. The type of pattern to match against.
},
],
- "requiredPaths": [ # Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: “required_paths: { pattern: "foo/bar/*” type: GLOB }
+ "requiredPaths": [ # Optional. A list of file paths patterns that trigger a build and rollout if at least one of the changed files in the commit are present in this list. This field is optional; the rollout policy will default to triggering on all paths if both ignored_paths and required_paths are not populated. Limited to 100 paths. Example: ``` required_paths: { pattern: "foo/bar/*", type: "GLOB" } ```
{ # A file path pattern to match against.
"pattern": "A String", # Optional. The pattern to match against.
"type": "A String", # Optional. The type of pattern to match against.
diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html
index 3666708b60..856826b940 100644
--- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html
+++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html
@@ -381,7 +381,6 @@ 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.
},
"computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
- "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request.
"environment": "A String", # Required. The environment being operated.
"excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
"A String",
@@ -939,7 +938,6 @@ 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.
},
"computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
- "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request.
"environment": "A String", # Required. The environment being operated.
"excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
"A String",
@@ -1773,7 +1771,6 @@ 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.
},
"computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
- "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request.
"environment": "A String", # Required. The environment being operated.
"excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
"A String",
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html
index 38850112a9..035165033e 100644
--- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html
+++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html
@@ -265,6 +265,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -296,6 +304,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -365,6 +381,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
index c55bd59989..8b3bb39961 100644
--- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
+++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
@@ -475,6 +475,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -506,6 +514,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -575,6 +591,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -765,6 +789,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -796,6 +828,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -865,6 +905,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -992,6 +1040,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -1023,6 +1079,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -1092,6 +1156,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -1489,6 +1561,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -1520,6 +1600,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -1589,6 +1677,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -1956,6 +2052,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -1987,6 +2091,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -2056,6 +2168,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -2264,6 +2384,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -2295,6 +2423,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -2364,6 +2500,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -2554,6 +2698,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -2585,6 +2737,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -2654,6 +2814,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html
index b5d1ef4589..b934752f20 100644
--- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html
+++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html
@@ -224,6 +224,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -255,6 +263,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
@@ -324,6 +340,14 @@ Method Details
"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",
],
+ "customRegexes": [ # Optional. Custom regex patterns to redact from the image.
+ { # Defines a custom regular expression pattern to detect and redact in the image.
+ "groupIndexes": [ # Optional. The capturing group indexes to redact. skip_request_analyics: true
+ 42,
+ ],
+ "pattern": "A String", # Optional. The regular expression pattern to match.
+ },
+ ],
"excludeInfoTypes": [ # InfoTypes to skip redacting, overriding those used by `text_redaction_mode`. Can only be used when `text_redaction_mode` is set to `REDACT_SENSITIVE_TEXT` or `REDACT_SENSITIVE_TEXT_CLEAN_DESCRIPTORS`.
"A String",
],
diff --git a/docs/dyn/memcache_v1.projects.locations.html b/docs/dyn/memcache_v1.projects.locations.html
index bbd4ebd39b..680e6a02ea 100644
--- a/docs/dyn/memcache_v1.projects.locations.html
+++ b/docs/dyn/memcache_v1.projects.locations.html
@@ -92,7 +92,7 @@ Instance Methods
Gets information about a location.
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
-Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -131,11 +131,11 @@ Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
- Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+ Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Args:
name: string, 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. Do not use this field unless explicitly documented otherwise. This is primarily 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/memcache_v1beta2.projects.locations.html b/docs/dyn/memcache_v1beta2.projects.locations.html
index f143be4f7d..f9a7233bc5 100644
--- a/docs/dyn/memcache_v1beta2.projects.locations.html
+++ b/docs/dyn/memcache_v1beta2.projects.locations.html
@@ -92,7 +92,7 @@ Instance Methods
Gets information about a location.
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
-Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Retrieves the next page of results.
@@ -131,11 +131,11 @@ Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
- Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+ Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Args:
name: string, 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. Do not use this field unless explicitly documented otherwise. This is primarily 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/merchantapi_products_v1.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html
index 0019b0e25d..5d0b66aa93 100644
--- a/docs/dyn/merchantapi_products_v1.accounts.productInputs.html
+++ b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html
@@ -233,6 +233,9 @@ Method Details
],
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).
+ "documentLinks": [ # Optional. Contains a list of PDF [document URLs](https://support.google.com/merchants/answer/17084656) for the product. Examples are training manuals, user guides, assembly instructions, package inserts, etc. Must start with "http://" or "https://"), ASCII characters only, and RFC 3986 compliant.
+ "A String",
+ ],
"electricRange": { # The mileage of the vehicle. # The [electric range](https://support.google.com/google-ads/answer/15162232) of the vehicle in miles/kms.
"unit": "A String", # The unit of the mileage.
"value": "A String", # The distance value.
@@ -303,6 +306,7 @@ Method Details
},
"isBundle": True or False, # Whether the item is a business-defined sub-API. A [sub-API] (https://support.google.com/merchants/answer/6324449) is a custom grouping of different products sold by a business for a single price.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
+ "itemGroupTitle": "A String", # Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently.
"lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information.
"A String",
],
@@ -376,6 +380,7 @@ Method Details
},
"pickupMethod": "A String", # The [pickup](https://support.google.com/merchants/answer/14634021) option for the item.
"pickupSla": "A String", # Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400).
+ "popularityRank": 3.14, # Optional. Indicates the [popularity](https://support.google.com/merchants/answer/17085297) of the product in a merchant's inventory. Using a scale of 0.0 (lowest) to 100.0 (highest).
"price": { # The price represented as a number and currency. # Price of the item.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
@@ -412,6 +417,19 @@ Method Details
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
+ "questionsAndAnswers": [ # Optional. Contains user-, merchant-, and manufacturer-authored [questions and answers](https://support.google.com/merchants/answer/17085211) about the product. Max 30 question and answer pairs. Max 5000 characters total. Each question can have max 1000 characters. Each answer can have max 1000 characters.
+ { # The question and answer for the product.
+ "answer": "A String", # Required. The answer text.
+ "question": "A String", # Required. The question text.
+ },
+ ],
+ "relatedProducts": [ # Optional. Specifies how other [products are related](https://support.google.com/merchants/answer/17085213) to this product.
+ { # Specifies how other products are related to this product.
+ "id": "A String", # Required. The identifier of the related product.
+ "idType": "A String", # Required. The type of the identifier of the related product. For example, [GTIN](https://support.google.com/merchants/answer/6219078) or [product ID](https://support.google.com/merchants/answer/6324405).
+ "relationshipType": "A String", # Required. The type of the relationship between this product and the related product.
+ },
+ ],
"returnPolicyLabel": "A String", # The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425).
"salePrice": { # The price represented as a number and currency. # Advertised sale price of the item.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
@@ -518,6 +536,12 @@ Method Details
"unit": "A String", # The unit of the measure.
"value": 3.14, # The measure of an item.
},
+ "variantOptions": [ # Optional. Contains the [list of all variant-identifying options](https://support.google.com/merchants/answer/17085214) of this product.
+ { # Additional product variants for the product.
+ "name": "A String", # Required. The name of the variant. For example, "Color", "Memory", "Size", "Length"
+ "value": "A String", # Required. The value of the variant. For example, "Red", "128GB", "XL", "100cm"
+ },
+ ],
"vehicleAllInPrice": { # The price represented as a number and currency. # The all-in advertised price for a vehicle, which includes costs for the following – any accessories attached to the vehicle, environmental levies, extra warranty, fuel, freight, pre-delivery inspection (PDI), dealer fees for handling licensing, provincial regulatory fees, miscellaneous dealer charges for security etching and nitrogen tire fill, and factory-to-customer or dealer-to-customer discounts or incentives. See the [Vehicle all-in price](https://support.google.com/google-ads/answer/14156981) for more information.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
@@ -671,6 +695,9 @@ Method Details
],
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).
+ "documentLinks": [ # Optional. Contains a list of PDF [document URLs](https://support.google.com/merchants/answer/17084656) for the product. Examples are training manuals, user guides, assembly instructions, package inserts, etc. Must start with "http://" or "https://"), ASCII characters only, and RFC 3986 compliant.
+ "A String",
+ ],
"electricRange": { # The mileage of the vehicle. # The [electric range](https://support.google.com/google-ads/answer/15162232) of the vehicle in miles/kms.
"unit": "A String", # The unit of the mileage.
"value": "A String", # The distance value.
@@ -741,6 +768,7 @@ Method Details
},
"isBundle": True or False, # Whether the item is a business-defined sub-API. A [sub-API] (https://support.google.com/merchants/answer/6324449) is a custom grouping of different products sold by a business for a single price.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
+ "itemGroupTitle": "A String", # Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently.
"lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information.
"A String",
],
@@ -814,6 +842,7 @@ Method Details
},
"pickupMethod": "A String", # The [pickup](https://support.google.com/merchants/answer/14634021) option for the item.
"pickupSla": "A String", # Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400).
+ "popularityRank": 3.14, # Optional. Indicates the [popularity](https://support.google.com/merchants/answer/17085297) of the product in a merchant's inventory. Using a scale of 0.0 (lowest) to 100.0 (highest).
"price": { # The price represented as a number and currency. # Price of the item.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
@@ -850,6 +879,19 @@ Method Details
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
+ "questionsAndAnswers": [ # Optional. Contains user-, merchant-, and manufacturer-authored [questions and answers](https://support.google.com/merchants/answer/17085211) about the product. Max 30 question and answer pairs. Max 5000 characters total. Each question can have max 1000 characters. Each answer can have max 1000 characters.
+ { # The question and answer for the product.
+ "answer": "A String", # Required. The answer text.
+ "question": "A String", # Required. The question text.
+ },
+ ],
+ "relatedProducts": [ # Optional. Specifies how other [products are related](https://support.google.com/merchants/answer/17085213) to this product.
+ { # Specifies how other products are related to this product.
+ "id": "A String", # Required. The identifier of the related product.
+ "idType": "A String", # Required. The type of the identifier of the related product. For example, [GTIN](https://support.google.com/merchants/answer/6219078) or [product ID](https://support.google.com/merchants/answer/6324405).
+ "relationshipType": "A String", # Required. The type of the relationship between this product and the related product.
+ },
+ ],
"returnPolicyLabel": "A String", # The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425).
"salePrice": { # The price represented as a number and currency. # Advertised sale price of the item.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
@@ -956,6 +998,12 @@ Method Details
"unit": "A String", # The unit of the measure.
"value": 3.14, # The measure of an item.
},
+ "variantOptions": [ # Optional. Contains the [list of all variant-identifying options](https://support.google.com/merchants/answer/17085214) of this product.
+ { # Additional product variants for the product.
+ "name": "A String", # Required. The name of the variant. For example, "Color", "Memory", "Size", "Length"
+ "value": "A String", # Required. The value of the variant. For example, "Red", "128GB", "XL", "100cm"
+ },
+ ],
"vehicleAllInPrice": { # The price represented as a number and currency. # The all-in advertised price for a vehicle, which includes costs for the following – any accessories attached to the vehicle, environmental levies, extra warranty, fuel, freight, pre-delivery inspection (PDI), dealer fees for handling licensing, provincial regulatory fees, miscellaneous dealer charges for security etching and nitrogen tire fill, and factory-to-customer or dealer-to-customer discounts or incentives. See the [Vehicle all-in price](https://support.google.com/google-ads/answer/14156981) for more information.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
@@ -1110,6 +1158,9 @@ Method Details
],
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).
+ "documentLinks": [ # Optional. Contains a list of PDF [document URLs](https://support.google.com/merchants/answer/17084656) for the product. Examples are training manuals, user guides, assembly instructions, package inserts, etc. Must start with "http://" or "https://"), ASCII characters only, and RFC 3986 compliant.
+ "A String",
+ ],
"electricRange": { # The mileage of the vehicle. # The [electric range](https://support.google.com/google-ads/answer/15162232) of the vehicle in miles/kms.
"unit": "A String", # The unit of the mileage.
"value": "A String", # The distance value.
@@ -1180,6 +1231,7 @@ Method Details
},
"isBundle": True or False, # Whether the item is a business-defined sub-API. A [sub-API] (https://support.google.com/merchants/answer/6324449) is a custom grouping of different products sold by a business for a single price.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
+ "itemGroupTitle": "A String", # Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently.
"lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information.
"A String",
],
@@ -1253,6 +1305,7 @@ Method Details
},
"pickupMethod": "A String", # The [pickup](https://support.google.com/merchants/answer/14634021) option for the item.
"pickupSla": "A String", # Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400).
+ "popularityRank": 3.14, # Optional. Indicates the [popularity](https://support.google.com/merchants/answer/17085297) of the product in a merchant's inventory. Using a scale of 0.0 (lowest) to 100.0 (highest).
"price": { # The price represented as a number and currency. # Price of the item.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
@@ -1289,6 +1342,19 @@ Method Details
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
+ "questionsAndAnswers": [ # Optional. Contains user-, merchant-, and manufacturer-authored [questions and answers](https://support.google.com/merchants/answer/17085211) about the product. Max 30 question and answer pairs. Max 5000 characters total. Each question can have max 1000 characters. Each answer can have max 1000 characters.
+ { # The question and answer for the product.
+ "answer": "A String", # Required. The answer text.
+ "question": "A String", # Required. The question text.
+ },
+ ],
+ "relatedProducts": [ # Optional. Specifies how other [products are related](https://support.google.com/merchants/answer/17085213) to this product.
+ { # Specifies how other products are related to this product.
+ "id": "A String", # Required. The identifier of the related product.
+ "idType": "A String", # Required. The type of the identifier of the related product. For example, [GTIN](https://support.google.com/merchants/answer/6219078) or [product ID](https://support.google.com/merchants/answer/6324405).
+ "relationshipType": "A String", # Required. The type of the relationship between this product and the related product.
+ },
+ ],
"returnPolicyLabel": "A String", # The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425).
"salePrice": { # The price represented as a number and currency. # Advertised sale price of the item.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
@@ -1395,6 +1461,12 @@ Method Details
"unit": "A String", # The unit of the measure.
"value": 3.14, # The measure of an item.
},
+ "variantOptions": [ # Optional. Contains the [list of all variant-identifying options](https://support.google.com/merchants/answer/17085214) of this product.
+ { # Additional product variants for the product.
+ "name": "A String", # Required. The name of the variant. For example, "Color", "Memory", "Size", "Length"
+ "value": "A String", # Required. The value of the variant. For example, "Red", "128GB", "XL", "100cm"
+ },
+ ],
"vehicleAllInPrice": { # The price represented as a number and currency. # The all-in advertised price for a vehicle, which includes costs for the following – any accessories attached to the vehicle, environmental levies, extra warranty, fuel, freight, pre-delivery inspection (PDI), dealer fees for handling licensing, provincial regulatory fees, miscellaneous dealer charges for security etching and nitrogen tire fill, and factory-to-customer or dealer-to-customer discounts or incentives. See the [Vehicle all-in price](https://support.google.com/google-ads/answer/14156981) for more information.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
@@ -1549,6 +1621,9 @@ Method Details
],
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).
+ "documentLinks": [ # Optional. Contains a list of PDF [document URLs](https://support.google.com/merchants/answer/17084656) for the product. Examples are training manuals, user guides, assembly instructions, package inserts, etc. Must start with "http://" or "https://"), ASCII characters only, and RFC 3986 compliant.
+ "A String",
+ ],
"electricRange": { # The mileage of the vehicle. # The [electric range](https://support.google.com/google-ads/answer/15162232) of the vehicle in miles/kms.
"unit": "A String", # The unit of the mileage.
"value": "A String", # The distance value.
@@ -1619,6 +1694,7 @@ Method Details
},
"isBundle": True or False, # Whether the item is a business-defined sub-API. A [sub-API] (https://support.google.com/merchants/answer/6324449) is a custom grouping of different products sold by a business for a single price.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
+ "itemGroupTitle": "A String", # Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently.
"lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information.
"A String",
],
@@ -1692,6 +1768,7 @@ Method Details
},
"pickupMethod": "A String", # The [pickup](https://support.google.com/merchants/answer/14634021) option for the item.
"pickupSla": "A String", # Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400).
+ "popularityRank": 3.14, # Optional. Indicates the [popularity](https://support.google.com/merchants/answer/17085297) of the product in a merchant's inventory. Using a scale of 0.0 (lowest) to 100.0 (highest).
"price": { # The price represented as a number and currency. # Price of the item.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
@@ -1728,6 +1805,19 @@ Method Details
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
+ "questionsAndAnswers": [ # Optional. Contains user-, merchant-, and manufacturer-authored [questions and answers](https://support.google.com/merchants/answer/17085211) about the product. Max 30 question and answer pairs. Max 5000 characters total. Each question can have max 1000 characters. Each answer can have max 1000 characters.
+ { # The question and answer for the product.
+ "answer": "A String", # Required. The answer text.
+ "question": "A String", # Required. The question text.
+ },
+ ],
+ "relatedProducts": [ # Optional. Specifies how other [products are related](https://support.google.com/merchants/answer/17085213) to this product.
+ { # Specifies how other products are related to this product.
+ "id": "A String", # Required. The identifier of the related product.
+ "idType": "A String", # Required. The type of the identifier of the related product. For example, [GTIN](https://support.google.com/merchants/answer/6219078) or [product ID](https://support.google.com/merchants/answer/6324405).
+ "relationshipType": "A String", # Required. The type of the relationship between this product and the related product.
+ },
+ ],
"returnPolicyLabel": "A String", # The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425).
"salePrice": { # The price represented as a number and currency. # Advertised sale price of the item.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
@@ -1834,6 +1924,12 @@ Method Details
"unit": "A String", # The unit of the measure.
"value": 3.14, # The measure of an item.
},
+ "variantOptions": [ # Optional. Contains the [list of all variant-identifying options](https://support.google.com/merchants/answer/17085214) of this product.
+ { # Additional product variants for the product.
+ "name": "A String", # Required. The name of the variant. For example, "Color", "Memory", "Size", "Length"
+ "value": "A String", # Required. The value of the variant. For example, "Red", "128GB", "XL", "100cm"
+ },
+ ],
"vehicleAllInPrice": { # The price represented as a number and currency. # The all-in advertised price for a vehicle, which includes costs for the following – any accessories attached to the vehicle, environmental levies, extra warranty, fuel, freight, pre-delivery inspection (PDI), dealer fees for handling licensing, provincial regulatory fees, miscellaneous dealer charges for security etching and nitrogen tire fill, and factory-to-customer or dealer-to-customer discounts or incentives. See the [Vehicle all-in price](https://support.google.com/google-ads/answer/14156981) for more information.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
diff --git a/docs/dyn/merchantapi_products_v1.accounts.products.html b/docs/dyn/merchantapi_products_v1.accounts.products.html
index 6104f57056..bc3e990ee2 100644
--- a/docs/dyn/merchantapi_products_v1.accounts.products.html
+++ b/docs/dyn/merchantapi_products_v1.accounts.products.html
@@ -233,6 +233,9 @@ Method Details
],
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).
+ "documentLinks": [ # Optional. Contains a list of PDF [document URLs](https://support.google.com/merchants/answer/17084656) for the product. Examples are training manuals, user guides, assembly instructions, package inserts, etc. Must start with "http://" or "https://"), ASCII characters only, and RFC 3986 compliant.
+ "A String",
+ ],
"electricRange": { # The mileage of the vehicle. # The [electric range](https://support.google.com/google-ads/answer/15162232) of the vehicle in miles/kms.
"unit": "A String", # The unit of the mileage.
"value": "A String", # The distance value.
@@ -303,6 +306,7 @@ Method Details
},
"isBundle": True or False, # Whether the item is a business-defined sub-API. A [sub-API] (https://support.google.com/merchants/answer/6324449) is a custom grouping of different products sold by a business for a single price.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
+ "itemGroupTitle": "A String", # Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently.
"lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information.
"A String",
],
@@ -376,6 +380,7 @@ Method Details
},
"pickupMethod": "A String", # The [pickup](https://support.google.com/merchants/answer/14634021) option for the item.
"pickupSla": "A String", # Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400).
+ "popularityRank": 3.14, # Optional. Indicates the [popularity](https://support.google.com/merchants/answer/17085297) of the product in a merchant's inventory. Using a scale of 0.0 (lowest) to 100.0 (highest).
"price": { # The price represented as a number and currency. # Price of the item.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
@@ -412,6 +417,19 @@ Method Details
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
+ "questionsAndAnswers": [ # Optional. Contains user-, merchant-, and manufacturer-authored [questions and answers](https://support.google.com/merchants/answer/17085211) about the product. Max 30 question and answer pairs. Max 5000 characters total. Each question can have max 1000 characters. Each answer can have max 1000 characters.
+ { # The question and answer for the product.
+ "answer": "A String", # Required. The answer text.
+ "question": "A String", # Required. The question text.
+ },
+ ],
+ "relatedProducts": [ # Optional. Specifies how other [products are related](https://support.google.com/merchants/answer/17085213) to this product.
+ { # Specifies how other products are related to this product.
+ "id": "A String", # Required. The identifier of the related product.
+ "idType": "A String", # Required. The type of the identifier of the related product. For example, [GTIN](https://support.google.com/merchants/answer/6219078) or [product ID](https://support.google.com/merchants/answer/6324405).
+ "relationshipType": "A String", # Required. The type of the relationship between this product and the related product.
+ },
+ ],
"returnPolicyLabel": "A String", # The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425).
"salePrice": { # The price represented as a number and currency. # Advertised sale price of the item.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
@@ -518,6 +536,12 @@ Method Details
"unit": "A String", # The unit of the measure.
"value": 3.14, # The measure of an item.
},
+ "variantOptions": [ # Optional. Contains the [list of all variant-identifying options](https://support.google.com/merchants/answer/17085214) of this product.
+ { # Additional product variants for the product.
+ "name": "A String", # Required. The name of the variant. For example, "Color", "Memory", "Size", "Length"
+ "value": "A String", # Required. The value of the variant. For example, "Red", "128GB", "XL", "100cm"
+ },
+ ],
"vehicleAllInPrice": { # The price represented as a number and currency. # The all-in advertised price for a vehicle, which includes costs for the following – any accessories attached to the vehicle, environmental levies, extra warranty, fuel, freight, pre-delivery inspection (PDI), dealer fees for handling licensing, provincial regulatory fees, miscellaneous dealer charges for security etching and nitrogen tire fill, and factory-to-customer or dealer-to-customer discounts or incentives. See the [Vehicle all-in price](https://support.google.com/google-ads/answer/14156981) for more information.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
@@ -730,6 +754,9 @@ Method Details
],
"displayAdsTitle": "A String", # Title of an item for dynamic remarketing campaigns.
"displayAdsValue": 3.14, # Offer margin for dynamic remarketing campaigns. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).
+ "documentLinks": [ # Optional. Contains a list of PDF [document URLs](https://support.google.com/merchants/answer/17084656) for the product. Examples are training manuals, user guides, assembly instructions, package inserts, etc. Must start with "http://" or "https://"), ASCII characters only, and RFC 3986 compliant.
+ "A String",
+ ],
"electricRange": { # The mileage of the vehicle. # The [electric range](https://support.google.com/google-ads/answer/15162232) of the vehicle in miles/kms.
"unit": "A String", # The unit of the mileage.
"value": "A String", # The distance value.
@@ -800,6 +827,7 @@ Method Details
},
"isBundle": True or False, # Whether the item is a business-defined sub-API. A [sub-API] (https://support.google.com/merchants/answer/6324449) is a custom grouping of different products sold by a business for a single price.
"itemGroupId": "A String", # Shared identifier for all variants of the same product.
+ "itemGroupTitle": "A String", # Optional. Represents the [title of the product group](https://support.google.com/merchants/answer/17085146) to which this variant product belongs. This can be used along with the [item group id](https://support.google.com/merchants/answer/6324507) attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently.
"lifestyleImageLinks": [ # Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the [Help Center article](https://support.google.com/merchants/answer/9103186) for more information.
"A String",
],
@@ -873,6 +901,7 @@ Method Details
},
"pickupMethod": "A String", # The [pickup](https://support.google.com/merchants/answer/14634021) option for the item.
"pickupSla": "A String", # Item store pickup timeline. For more information, see [Pickup SLA](https://support.google.com/merchants/answer/14635400).
+ "popularityRank": 3.14, # Optional. Indicates the [popularity](https://support.google.com/merchants/answer/17085297) of the product in a merchant's inventory. Using a scale of 0.0 (lowest) to 100.0 (highest).
"price": { # The price represented as a number and currency. # Price of the item.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
@@ -909,6 +938,19 @@ Method Details
"promotionIds": [ # The unique ID of a promotion.
"A String",
],
+ "questionsAndAnswers": [ # Optional. Contains user-, merchant-, and manufacturer-authored [questions and answers](https://support.google.com/merchants/answer/17085211) about the product. Max 30 question and answer pairs. Max 5000 characters total. Each question can have max 1000 characters. Each answer can have max 1000 characters.
+ { # The question and answer for the product.
+ "answer": "A String", # Required. The answer text.
+ "question": "A String", # Required. The question text.
+ },
+ ],
+ "relatedProducts": [ # Optional. Specifies how other [products are related](https://support.google.com/merchants/answer/17085213) to this product.
+ { # Specifies how other products are related to this product.
+ "id": "A String", # Required. The identifier of the related product.
+ "idType": "A String", # Required. The type of the identifier of the related product. For example, [GTIN](https://support.google.com/merchants/answer/6219078) or [product ID](https://support.google.com/merchants/answer/6324405).
+ "relationshipType": "A String", # Required. The type of the relationship between this product and the related product.
+ },
+ ],
"returnPolicyLabel": "A String", # The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see [Return policy label](https://support.google.com/merchants/answer/9445425).
"salePrice": { # The price represented as a number and currency. # Advertised sale price of the item.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
@@ -1015,6 +1057,12 @@ Method Details
"unit": "A String", # The unit of the measure.
"value": 3.14, # The measure of an item.
},
+ "variantOptions": [ # Optional. Contains the [list of all variant-identifying options](https://support.google.com/merchants/answer/17085214) of this product.
+ { # Additional product variants for the product.
+ "name": "A String", # Required. The name of the variant. For example, "Color", "Memory", "Size", "Length"
+ "value": "A String", # Required. The value of the variant. For example, "Red", "128GB", "XL", "100cm"
+ },
+ ],
"vehicleAllInPrice": { # The price represented as a number and currency. # The all-in advertised price for a vehicle, which includes costs for the following – any accessories attached to the vehicle, environmental levies, extra warranty, fuel, freight, pre-delivery inspection (PDI), dealer fees for handling licensing, provincial regulatory fees, miscellaneous dealer charges for security etching and nitrogen tire fill, and factory-to-customer or dealer-to-customer discounts or incentives. See the [Vehicle all-in price](https://support.google.com/google-ads/answer/14156981) for more information.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
diff --git a/docs/dyn/mybusinessverifications_v1.verificationTokens.html b/docs/dyn/mybusinessverifications_v1.verificationTokens.html
index 243615dbf0..143a888325 100644
--- a/docs/dyn/mybusinessverifications_v1.verificationTokens.html
+++ b/docs/dyn/mybusinessverifications_v1.verificationTokens.html
@@ -95,7 +95,7 @@ Method Details
The object takes the form of:
{ # Request message for Verifications.GenerateInstantVerificationToken.
- "locationData": { # The address and other details of the location to generate an instant verification token for. # Immutable. The address and other details of the location to generate an instant verification token for.
+ "locationData": { # The address and other details of the location to generate an instant verification token for. # Immutable. Deprecated: Please use location_id instead. The address and other details of the location to generate an instant verification token for.
"address": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Immutable. A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five `address_lines` values in the address.
"addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
"A String",
diff --git a/docs/dyn/netapp_v1.projects.locations.backupVaults.backups.html b/docs/dyn/netapp_v1.projects.locations.backupVaults.backups.html
index f30b014479..42105d155d 100644
--- a/docs/dyn/netapp_v1.projects.locations.backupVaults.backups.html
+++ b/docs/dyn/netapp_v1.projects.locations.backupVaults.backups.html
@@ -121,6 +121,11 @@ Method Details
"a_key": "A String",
},
"name": "A String", # Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.
+ "ontapSource": { # Represents ONTAP source details. # Optional. Represents source details for ONTAP backups. Either source_volume or ontap_source should be provided.
+ "snapshotUuid": "A String", # Optional. The UUID of the ONTAP source snapshot.
+ "storagePool": "A String", # Required. Name of the storage pool. This must be specified for creating backups for ONTAP mode volumes. Format: `projects/{projects_id}/locations/{location}/storagePools/{storage_pool_id}`
+ "volumeUuid": "A String", # Required. The UUID of the ONTAP source volume.
+ },
"satisfiesPzi": True or False, # Output only. Reserved for future use
"satisfiesPzs": True or False, # Output only. Reserved for future use
"sourceSnapshot": "A String", # If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`
@@ -220,6 +225,11 @@ Method Details
"a_key": "A String",
},
"name": "A String", # Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.
+ "ontapSource": { # Represents ONTAP source details. # Optional. Represents source details for ONTAP backups. Either source_volume or ontap_source should be provided.
+ "snapshotUuid": "A String", # Optional. The UUID of the ONTAP source snapshot.
+ "storagePool": "A String", # Required. Name of the storage pool. This must be specified for creating backups for ONTAP mode volumes. Format: `projects/{projects_id}/locations/{location}/storagePools/{storage_pool_id}`
+ "volumeUuid": "A String", # Required. The UUID of the ONTAP source volume.
+ },
"satisfiesPzi": True or False, # Output only. Reserved for future use
"satisfiesPzs": True or False, # Output only. Reserved for future use
"sourceSnapshot": "A String", # If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`
@@ -261,6 +271,11 @@ Method Details
"a_key": "A String",
},
"name": "A String", # Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.
+ "ontapSource": { # Represents ONTAP source details. # Optional. Represents source details for ONTAP backups. Either source_volume or ontap_source should be provided.
+ "snapshotUuid": "A String", # Optional. The UUID of the ONTAP source snapshot.
+ "storagePool": "A String", # Required. Name of the storage pool. This must be specified for creating backups for ONTAP mode volumes. Format: `projects/{projects_id}/locations/{location}/storagePools/{storage_pool_id}`
+ "volumeUuid": "A String", # Required. The UUID of the ONTAP source volume.
+ },
"satisfiesPzi": True or False, # Output only. Reserved for future use
"satisfiesPzs": True or False, # Output only. Reserved for future use
"sourceSnapshot": "A String", # If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`
@@ -311,6 +326,11 @@ Method Details
"a_key": "A String",
},
"name": "A String", # Identifier. The resource name of the backup. Format: `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`.
+ "ontapSource": { # Represents ONTAP source details. # Optional. Represents source details for ONTAP backups. Either source_volume or ontap_source should be provided.
+ "snapshotUuid": "A String", # Optional. The UUID of the ONTAP source snapshot.
+ "storagePool": "A String", # Required. Name of the storage pool. This must be specified for creating backups for ONTAP mode volumes. Format: `projects/{projects_id}/locations/{location}/storagePools/{storage_pool_id}`
+ "volumeUuid": "A String", # Required. The UUID of the ONTAP source volume.
+ },
"satisfiesPzi": True or False, # Output only. Reserved for future use
"satisfiesPzs": True or False, # Output only. Reserved for future use
"sourceSnapshot": "A String", # If specified, backup will be created from the given snapshot. If not specified, there will be a new snapshot taken to initiate the backup creation. Format: `projects/{project_id}/locations/{location}/volumes/{volume_id}/snapshots/{snapshot_id}`
diff --git a/docs/dyn/netapp_v1.projects.locations.storagePools.backupConfigs.html b/docs/dyn/netapp_v1.projects.locations.storagePools.backupConfigs.html
new file mode 100644
index 0000000000..0dd524d7c4
--- /dev/null
+++ b/docs/dyn/netapp_v1.projects.locations.storagePools.backupConfigs.html
@@ -0,0 +1,145 @@
+
+
+
+NetApp API . projects . locations . storagePools . backupConfigs
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists backup configurations for all volumes in an ONTAP-mode Storage Pool.
+
+Retrieves the next page of results.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists backup configurations for all volumes in an ONTAP-mode Storage Pool.
+
+Args:
+ parent: string, Required. The ONTAP StoragePool for which to retrieve backup configuration information, in the format `projects/{project}/locations/{location}/storagePools/{storage_pool}`. (required)
+ filter: string, Optional. The standard list filter.
+ orderBy: string, Optional. Sort results. Supported values are "volume_id" or ""
+ pageSize: integer, Optional. The maximum number of items to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified or set to 0, a default of 50 will be used.
+ pageToken: string, Optional. The next_page_token value to use if there are additional results to retrieve for this list request.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message for response to listing BackupConfigs in an ONTAP StoragePool.
+ "nextPageToken": "A String", # The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
+ "unreachable": [ # Unordered list. Locations that could not be reached.
+ "A String",
+ ],
+ "volumeBackupConfigs": [ # A list of backup configurations for volumes in the pool.
+ { # Backup configuration for a volume in a pool.
+ "backupConfig": { # BackupConfig contains backup related config on a volume. # Backup configuration for the volume.
+ "backupChainBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).
+ "backupPolicies": [ # Optional. When specified, schedule backups will be created based on the policy configuration.
+ "A String",
+ ],
+ "backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
+ "scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
+ },
+ "volumeUuid": "A String", # Provides the Ontap UUID of the volume within the pool.
+ },
+ ],
+}
+
+
+
+ list_next()
+ Retrieves the next page of results.
+
+ Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+ Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/netapp_v1.projects.locations.storagePools.html b/docs/dyn/netapp_v1.projects.locations.storagePools.html
index 5ebbee9605..ebfac2ff1f 100644
--- a/docs/dyn/netapp_v1.projects.locations.storagePools.html
+++ b/docs/dyn/netapp_v1.projects.locations.storagePools.html
@@ -74,6 +74,11 @@
NetApp API . projects . locations . storagePools
Instance Methods
+
+ backupConfigs()
+
+Returns the backupConfigs Resource.
+
@@ -100,9 +105,15 @@ Instance Methods
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the storage pool properties with the full spec
+
+ restoreVolume(name, body=None, x__xgafv=None)
+Restores a backup to an ONTAP-mode volume.
switch(name, body=None, x__xgafv=None)
This operation will switch the active/replica zone for a regional storagePool.
+
+ updateBackupConfig(name, body=None, x__xgafv=None)
+Updates the backup configuration for an ONTAP-mode volume.
validateDirectoryService(name, body=None, x__xgafv=None)
ValidateDirectoryService does a connectivity check for a directory service policy attached to the storage pool.
@@ -437,6 +448,57 @@ Method Details
}
+
+ restoreVolume(name, body=None, x__xgafv=None)
+ Restores a backup to an ONTAP-mode volume.
+
+Args:
+ name: string, Required. The resource name of the ONTAP mode storage pool, in the format of `projects/{project}/locations/{location}/storagePools/{storage_pool}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for `RestoreVolume` API.
+ "backupSource": { # Represents the backup source of the restore operation. # The backup source of the restore operation.
+ "backup": "A String", # Required. The backup resource name.
+ "fileList": [ # Optional. List of files to be restored in the form of their absolute path as in source volume. If provided, only these files will be restored. If not provided, the entire backup will be restored (Full Backup Restore)
+ "A String",
+ ],
+ },
+ "ontapVolumeTarget": { # Represents the ONTAP volume target of the restore operation. # The ONTAP volume target of the restore operation.
+ "restoreDestinationPath": "A String", # Optional. Absolute directory path in the destination volume.
+ "volumeUuid": "A String", # Required. The UUID of the ONTAP volume to restore to.
+ },
+}
+
+ 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.
+ },
+}
+
+
switch(name, body=None, x__xgafv=None)
This operation will switch the active/replica zone for a regional storagePool.
@@ -478,6 +540,57 @@ Method Details
}
+
+ updateBackupConfig(name, body=None, x__xgafv=None)
+ Updates the backup configuration for an ONTAP-mode volume.
+
+Args:
+ name: string, Required. The resource name of the StoragePool, in the format: projects/{projectNumber}/locations/{locationId}/storagePools/{poolId} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for UpdateBackupConfig
+ "backupConfig": { # BackupConfig contains backup related config on a volume. # Required. Backup configuration to apply.
+ "backupChainBytes": "A String", # Output only. Total size of all backups in a chain in bytes = baseline backup size + sum(incremental backup size).
+ "backupPolicies": [ # Optional. When specified, schedule backups will be created based on the policy configuration.
+ "A String",
+ ],
+ "backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
+ "scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
+ },
+ "updateMask": "A String", # Required. Field mask is used to specify the fields to be overwritten in the BackupConfig for the Volume. 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.
+ "volumeUuid": "A String", # Required. The UUID of the ONTAP-mode volume.
+}
+
+ 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.
+ },
+}
+
+
validateDirectoryService(name, body=None, x__xgafv=None)
ValidateDirectoryService does a connectivity check for a directory service policy attached to the storage pool.
diff --git a/docs/dyn/networkmanagement_v1.projects.locations.html b/docs/dyn/networkmanagement_v1.projects.locations.html
index 3a7f4cfad7..c3c8b0ca12 100644
--- a/docs/dyn/networkmanagement_v1.projects.locations.html
+++ b/docs/dyn/networkmanagement_v1.projects.locations.html
@@ -79,6 +79,11 @@ Instance Methods
Returns the global_ Resource.
+
+ networkMonitoringProviders()
+
+Returns the networkMonitoringProviders Resource.
+
diff --git a/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.html b/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.html
index 24508b7fbc..4e42f21525 100644
--- a/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.html
+++ b/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.html
@@ -96,8 +96,14 @@ Instance Methods
create(parent, body=None, networkMonitoringProviderId=None, x__xgafv=None)
Creates a NetworkMonitoringProvider resource.
+ delete(name, force=None, x__xgafv=None)
Deletes a NetworkMonitoringProvider resource and all of its child resources.
+
+ generateMonitoringPointConfig(name, x__xgafv=None)
+Generates Monitoring Point configuration of a NetworkMonitoringProvider resource.
+
+ generateProviderAccessToken(name, gcpAccessToken=None, x__xgafv=None)
+Generates a provider access token for a given Google access token. Provider access token is a short-lived token that is used to access resources in the provider's platform.
Gets the NetworkMonitoringProvider resource.
@@ -165,11 +171,12 @@ Method Details
- delete(name, x__xgafv=None)
+ delete(name, force=None, x__xgafv=None)
Deletes a NetworkMonitoringProvider resource and all of its child resources.
Args:
name: string, Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} (required)
+ force: boolean, Optional. If set to true, any nested MonitoringPoints, NetworkPaths and WebPaths resources from this NetworkMonitoringProvider will also be deleted. Otherwise, the request will only work if there are no nested resources.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -199,6 +206,47 @@ Method Details
}
+
+ generateMonitoringPointConfig(name, x__xgafv=None)
+ Generates Monitoring Point configuration of a NetworkMonitoringProvider resource.
+
+Args:
+ name: string, Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message for response for getting Monitoring Point configuration of a NetworkMonitoringProvider resource.
+ "config": { # The Monitoring Point configuration of the provider in JSON format.
+ "a_key": "", # Properties of the object.
+ },
+}
+
+
+
+ generateProviderAccessToken(name, gcpAccessToken=None, x__xgafv=None)
+ Generates a provider access token for a given Google access token. Provider access token is a short-lived token that is used to access resources in the provider's platform.
+
+Args:
+ name: string, Required. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} (required)
+ gcpAccessToken: string, Required. Google access token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message for response for generating an access token for a NetworkMonitoringProvider resource.
+ "providerAccessToken": "A String", # Provider access token for the NetworkMonitoringProvider resource.
+}
+
+
get(name, x__xgafv=None)
Gets the NetworkMonitoringProvider resource.
diff --git a/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.monitoringPoints.html b/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.monitoringPoints.html
index dde84031dc..761a6f30c5 100644
--- a/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.monitoringPoints.html
+++ b/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.monitoringPoints.html
@@ -77,6 +77,15 @@ Instance Methods
Close httplib2 connections.
+
+Downloads an install script for MonitoringPoints for a given network monitoring provider.
+
+ downloadRecreateInstallScript(name, hostname=None, x__xgafv=None)
+Downloads an install script for a specific Container MonitoringPoint.
+
+ downloadServerConnectConfig(parent, x__xgafv=None)
+Downloads the server connect configuration for a given network monitoring provider.
Gets the MonitoringPoint resource.
@@ -92,6 +101,103 @@ Method Details
Close httplib2 connections.
+
+ downloadInstallScript(parent, hostname=None, monitoringPointType=None, ntpServerAddress=None, ntpServerSecondaryAddress=None, staticIpAddress_dnsServerAddress=None, staticIpAddress_dnsServerSecondaryAddress=None, staticIpAddress_domain=None, staticIpAddress_gatewayAddress=None, staticIpAddress_ipAddress=None, staticIpAddress_netmask=None, timeZone_id=None, timeZone_version=None, useDhcp=None, x__xgafv=None, x_password=None)
+ Downloads an install script for MonitoringPoints for a given network monitoring provider.
+
+Args:
+ parent: string, Required. Parent value for DownloadInstallScriptRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} (required)
+ hostname: string, Required. The hostname of the MonitoringPoint, e.g. "test-vm"
+ monitoringPointType: string, Required. The type of the monitoring point.
+ Allowed values
+ MONITORING_POINT_TYPE_UNSPECIFIED - This value should not be used.
+ CONTAINER - Monitoring Point that runs in a Docker container.
+ KVM - Monitoring Point that runs in a Kernel-based Virtual Machine (KVM) hypervisor.
+ VMWARE - Monitoring Point that runs in a VMware hypervisor.
+ HELM - Monitoring Point that runs on a K8S Helm.
+ GCE_VM - Monitoring Point that runs as a startup script in a Compute Engine VM.
+ ntpServerAddress: string, Optional. Network Time Protocol a user can configure. If the user omits the field, the default is either NTP servers provided in the DHCP lease or a set of well-known NTP servers pre-configured on the monitoring point. This field can be an IP address or FQDN.
+ ntpServerSecondaryAddress: string, Optional. Second NTP server.
+ staticIpAddress_dnsServerAddress: string, Required. DNS server.
+ staticIpAddress_dnsServerSecondaryAddress: string, Optional. Second DNS server.
+ staticIpAddress_domain: string, Optional. Domain name of the MonitoringPoint.
+ staticIpAddress_gatewayAddress: string, Required. Gateway IP address. Example: "100.80.40.1".
+ staticIpAddress_ipAddress: string, Required. IP address of the MonitoringPoint.
+ staticIpAddress_netmask: string, Optional. Networkmask and CIDR range. Example: "255.255.255.0/24"
+ timeZone_id: string, IANA Time Zone Database time zone. For example "America/New_York".
+ timeZone_version: string, Optional. IANA Time Zone Database version number. For example "2019a".
+ useDhcp: boolean, Optional. Dynamic Host Configuration Protocol, is a network management protocol that automatically assigns IP addresses and other network configuration parameters to devices connecting to a network.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+ x_password: string, Optional. Password for logging into the MonitoringPoint.
+
+Returns:
+ An object of the form:
+
+ { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+}
+
+
+
+ downloadRecreateInstallScript(name, hostname=None, x__xgafv=None)
+ Downloads an install script for a specific Container MonitoringPoint.
+
+Args:
+ name: string, Required. Resource name of the MonitoringPoint. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}/monitoringPoints/{monitoring_point} (required)
+ hostname: string, Optional. The hostname of the MonitoringPoint, e.g. "test-vm"
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+}
+
+
+
+ downloadServerConnectConfig(parent, x__xgafv=None)
+ Downloads the server connect configuration for a given network monitoring provider.
+
+Args:
+ parent: string, Required. Parent value for DownloadServerConnectConfigRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+}
+
+
get(name, x__xgafv=None)
Gets the MonitoringPoint resource.
@@ -110,14 +216,16 @@ Method Details
"autoGeoLocationEnabled": True or False, # Output only. Indicates if automaitic geographic location is enabled for the MonitoringPoint.
"connectionStatus": "A String", # Output only. Connection status of the MonitoringPoint.
"createTime": "A String", # Output only. The time the MonitoringPoint was created.
+ "deploymentType": "A String", # Output only. The deployment type of the MonitoringPoint.
"displayName": "A String", # Output only. Display name of the MonitoringPoint.
"errors": [ # Output only. The codes of errors detected in the MonitoringPoint.
"A String",
],
- "geoLocation": { # The geographical location of the MonitoringPoint. # Output only. The geographical location of the MonitoringPoint. ;
- "country": "A String", # Country.
+ "geoLocation": { # The geographical location of the MonitoringPoint. # Output only. The geographical location of the MonitoringPoint.
"formattedAddress": "A String", # Formatted address.
+ "regionCode": "A String", # Unicode CLDR region code.
},
+ "guid": "A String", # Output only. The GUID of the MonitoringPoint.
"host": { # Message describing information about the host. # Output only. The host information of the MonitoringPoint.
"cloudInstanceId": "A String", # Output only. The cloud instance id of the host.
"cloudProjectId": "A String", # Output only. The cloud project id of the host.
@@ -126,7 +234,6 @@ Method Details
"cloudVirtualNetworkIds": [ # Output only. The ids of cloud virtual networks of the host.
"A String",
],
- "cloudVpcId": "A String", # Output only. The id of Virtual Private Cloud (VPC) of the host.
"cloudZone": "A String", # Output only. The cloud zone of the host.
"os": "A String", # Output only. The operating system of the host.
},
@@ -181,14 +288,16 @@ Method Details
"autoGeoLocationEnabled": True or False, # Output only. Indicates if automaitic geographic location is enabled for the MonitoringPoint.
"connectionStatus": "A String", # Output only. Connection status of the MonitoringPoint.
"createTime": "A String", # Output only. The time the MonitoringPoint was created.
+ "deploymentType": "A String", # Output only. The deployment type of the MonitoringPoint.
"displayName": "A String", # Output only. Display name of the MonitoringPoint.
"errors": [ # Output only. The codes of errors detected in the MonitoringPoint.
"A String",
],
- "geoLocation": { # The geographical location of the MonitoringPoint. # Output only. The geographical location of the MonitoringPoint. ;
- "country": "A String", # Country.
+ "geoLocation": { # The geographical location of the MonitoringPoint. # Output only. The geographical location of the MonitoringPoint.
"formattedAddress": "A String", # Formatted address.
+ "regionCode": "A String", # Unicode CLDR region code.
},
+ "guid": "A String", # Output only. The GUID of the MonitoringPoint.
"host": { # Message describing information about the host. # Output only. The host information of the MonitoringPoint.
"cloudInstanceId": "A String", # Output only. The cloud instance id of the host.
"cloudProjectId": "A String", # Output only. The cloud project id of the host.
@@ -197,7 +306,6 @@ Method Details
"cloudVirtualNetworkIds": [ # Output only. The ids of cloud virtual networks of the host.
"A String",
],
- "cloudVpcId": "A String", # Output only. The id of Virtual Private Cloud (VPC) of the host.
"cloudZone": "A String", # Output only. The cloud zone of the host.
"os": "A String", # Output only. The operating system of the host.
},
diff --git a/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.networkPaths.html b/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.networkPaths.html
index 2739ae15e1..529862fe16 100644
--- a/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.networkPaths.html
+++ b/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.networkPaths.html
@@ -109,10 +109,11 @@ Method Details
{ # Message describing NetworkPath resource.
"createTime": "A String", # Output only. The time the NetworkPath was created.
"destination": "A String", # Output only. IP address or hostname of the network path destination.
- "destinationGeoLocation": { # The geographical location of the MonitoringPoint. # Output only. Geographical location of the destination MonitoringPoint. ;
- "country": "A String", # Country.
+ "destinationGeoLocation": { # The geographical location of the MonitoringPoint. # Output only. Geographical location of the destination MonitoringPoint.
"formattedAddress": "A String", # Formatted address.
+ "regionCode": "A String", # Unicode CLDR region code.
},
+ "destinationMonitoringPointId": "A String", # Output only. Provider's UUID of the destination MonitoringPoint. This id may not point to a resource in the Google Cloud.
"displayName": "A String", # Output only. The display name of the network path.
"dualEnded": True or False, # 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).
"monitoringEnabled": True or False, # Output only. Is monitoring enabled for the network path.
@@ -129,7 +130,7 @@ Method Details
},
],
"providerUiUri": "A String", # Output only. Link to provider's UI; link shows the NetworkPath.
- "sourceMonitoringPointId": "A String", # Output only. Provider's UUID of the source MonitoringPoint. This id may not point to a resource in the GCP.
+ "sourceMonitoringPointId": "A String", # Output only. Provider's UUID of the source MonitoringPoint. This id may not point to a resource in the Google Cloud.
"updateTime": "A String", # Output only. The time the NetworkPath was updated.
}
@@ -155,10 +156,11 @@ Method Details
{ # Message describing NetworkPath resource.
"createTime": "A String", # Output only. The time the NetworkPath was created.
"destination": "A String", # Output only. IP address or hostname of the network path destination.
- "destinationGeoLocation": { # The geographical location of the MonitoringPoint. # Output only. Geographical location of the destination MonitoringPoint. ;
- "country": "A String", # Country.
+ "destinationGeoLocation": { # The geographical location of the MonitoringPoint. # Output only. Geographical location of the destination MonitoringPoint.
"formattedAddress": "A String", # Formatted address.
+ "regionCode": "A String", # Unicode CLDR region code.
},
+ "destinationMonitoringPointId": "A String", # Output only. Provider's UUID of the destination MonitoringPoint. This id may not point to a resource in the Google Cloud.
"displayName": "A String", # Output only. The display name of the network path.
"dualEnded": True or False, # 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).
"monitoringEnabled": True or False, # Output only. Is monitoring enabled for the network path.
@@ -175,7 +177,7 @@ Method Details
},
],
"providerUiUri": "A String", # Output only. Link to provider's UI; link shows the NetworkPath.
- "sourceMonitoringPointId": "A String", # Output only. Provider's UUID of the source MonitoringPoint. This id may not point to a resource in the GCP.
+ "sourceMonitoringPointId": "A String", # Output only. Provider's UUID of the source MonitoringPoint. This id may not point to a resource in the Google Cloud.
"updateTime": "A String", # Output only. The time the NetworkPath was updated.
},
],
diff --git a/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.webPaths.html b/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.webPaths.html
index 80cd387184..fd96cd1422 100644
--- a/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.webPaths.html
+++ b/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.webPaths.html
@@ -109,6 +109,10 @@ Method Details
{ # Message describing WebPath resource.
"createTime": "A String", # Output only. The time the WebPath was created.
"destination": "A String", # Output only. Web monitoring target.
+ "destinationGeoLocation": { # The geographical location of the MonitoringPoint. # Output only. Geographical location of the destination.
+ "formattedAddress": "A String", # Formatted address.
+ "regionCode": "A String", # Unicode CLDR region code.
+ },
"displayName": "A String", # Output only. Display name of the WebPath.
"interval": "A String", # Output only. Monitoring interval.
"monitoringEnabled": True or False, # Output only. Is monitoring enabled for the WebPath.
@@ -153,6 +157,10 @@ Method Details
{ # Message describing WebPath resource.
"createTime": "A String", # Output only. The time the WebPath was created.
"destination": "A String", # Output only. Web monitoring target.
+ "destinationGeoLocation": { # The geographical location of the MonitoringPoint. # Output only. Geographical location of the destination.
+ "formattedAddress": "A String", # Formatted address.
+ "regionCode": "A String", # Unicode CLDR region code.
+ },
"displayName": "A String", # Output only. Display name of the WebPath.
"interval": "A String", # Output only. Monitoring interval.
"monitoringEnabled": True or False, # Output only. Is monitoring enabled for the WebPath.
diff --git a/docs/dyn/networksecurity_v1.organizations.locations.addressGroups.html b/docs/dyn/networksecurity_v1.organizations.locations.addressGroups.html
index 6681614be1..6dd4b2e50d 100644
--- a/docs/dyn/networksecurity_v1.organizations.locations.addressGroups.html
+++ b/docs/dyn/networksecurity_v1.organizations.locations.addressGroups.html
@@ -110,6 +110,9 @@ Instance Methods
removeItems(addressGroup, body=None, x__xgafv=None)
Removes items from an address group.
+
+ 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
addItems(addressGroup, body=None, x__xgafv=None)
@@ -538,4 +541,34 @@ Method Details
}
+
+ 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",
+ ],
+}
+
+