diff --git a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html index ae2cd17f74f..c2bc44d120b 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.indexEndpoints.html @@ -177,6 +177,7 @@
create(body=None, x__xgafv=None)
Creates a Google Analytics property with the specified location and attributes.
-
- createConnectedSiteTag(body=None, x__xgafv=None)
Creates a connected site tag for a Universal Analytics property. You can create a maximum of 20 connected site tags per property. Note: This API cannot be used on GA4 properties.
createRollupProperty(body=None, x__xgafv=None)
Create a roll-up property and all roll-up property source links.
Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.
-
- deleteConnectedSiteTag(body=None, x__xgafv=None)
Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties.
-
- fetchAutomatedGa4ConfigurationOptOut(body=None, x__xgafv=None)
Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.
-
- fetchConnectedGa4Property(property=None, x__xgafv=None)
Given a specified UA property, looks up the GA4 property connected to it. Note: this cannot be used with GA4 properties.
Lookup for a single GA Property.
@@ -224,9 +212,6 @@
list(filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)
Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.
-
- listConnectedSiteTags(body=None, x__xgafv=None)
Lists the connected site tags for a Universal Analytics property. A maximum of 20 connected site tags will be returned. Note: this has no effect on GA4 property.
Retrieves the next page of results.
@@ -239,9 +224,6 @@
runAccessReport(entity, body=None, x__xgafv=None)
Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form.
-
- setAutomatedGa4ConfigurationOptOut(body=None, x__xgafv=None)
Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.
updateAttributionSettings(name, body=None, updateMask=None, x__xgafv=None)
Updates attribution settings on a property.
@@ -331,34 +313,6 @@createConnectedSiteTag(body=None, x__xgafv=None)
- Creates a connected site tag for a Universal Analytics property. You can create a maximum of 20 connected site tags per property. Note: This API cannot be used on GA4 properties.
-
-Args:
- body: object, The request body.
- The object takes the form of:
-
-{ # Request message for CreateConnectedSiteTag RPC.
- "connectedSiteTag": { # Configuration for a specific Connected Site Tag. # Required. The tag to add to the Universal Analytics property
- "displayName": "A String", # Required. User-provided display name for the connected site tag. Must be less than 256 characters.
- "tagId": "A String", # Required. "Tag ID to forward events to. Also known as the Measurement ID, or the "G-ID" (For example: G-12345).
- },
- "property": "A String", # The Universal Analytics property to create connected site tags for. This API does not support GA4 properties. Format: properties/{universalAnalyticsPropertyId} Example: properties/1234
-}
-
- 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 CreateConnectedSiteTag RPC.
-}
-createRollupProperty(body=None, x__xgafv=None)
Create a roll-up property and all roll-up property source links. @@ -452,75 +406,6 @@Method Details
}
deleteConnectedSiteTag(body=None, x__xgafv=None)
- Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties.
-
-Args:
- body: object, The request body.
- The object takes the form of:
-
-{ # Request message for DeleteConnectedSiteTag RPC.
- "property": "A String", # The Universal Analytics property to delete connected site tags for. This API does not support GA4 properties. Format: properties/{universalAnalyticsPropertyId} Example: properties/1234
- "tagId": "A String", # Tag ID to forward events to. Also known as the Measurement ID, or the "G-ID" (For example: G-12345).
-}
-
- 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); }
-}
-fetchAutomatedGa4ConfigurationOptOut(body=None, x__xgafv=None)
- Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.
-
-Args:
- body: object, The request body.
- The object takes the form of:
-
-{ # Request for fetching the opt out status for the automated GA4 setup process.
- "property": "A String", # Required. The UA property to get the opt out status. Note this request uses the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format: properties/{internalWebPropertyId} Example: properties/1234
-}
-
- 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 fetching the opt out status for the automated GA4 setup process.
- "optOut": True or False, # The opt out status for the UA property.
-}
-fetchConnectedGa4Property(property=None, x__xgafv=None)
- Given a specified UA property, looks up the GA4 property connected to it. Note: this cannot be used with GA4 properties.
-
-Args:
- property: string, Required. The UA property for which to look up the connected GA4 property. Note this request uses the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format: properties/{internal_web_property_id} Example: properties/1234
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Response for looking up GA4 property connected to a UA property.
- "property": "A String", # The GA4 property connected to the UA property. An empty string is returned when there is no connected GA4 property. Format: properties/{property_id} Example: properties/1234
-}
-get(name, x__xgafv=None)
Lookup for a single GA Property. @@ -677,36 +562,6 @@Method Details
}
listConnectedSiteTags(body=None, x__xgafv=None)
- Lists the connected site tags for a Universal Analytics property. A maximum of 20 connected site tags will be returned. Note: this has no effect on GA4 property.
-
-Args:
- body: object, The request body.
- The object takes the form of:
-
-{ # Request message for ListConnectedSiteTags RPC.
- "property": "A String", # The Universal Analytics property to fetch connected site tags for. This does not work on GA4 properties. A maximum of 20 connected site tags will be returned. Example Format: `properties/1234`
-}
-
- 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 ListConnectedSiteTags RPC.
- "connectedSiteTags": [ # The site tags for the Universal Analytics property. A maximum of 20 connected site tags will be returned.
- { # Configuration for a specific Connected Site Tag.
- "displayName": "A String", # Required. User-provided display name for the connected site tag. Must be less than 256 characters.
- "tagId": "A String", # Required. "Tag ID to forward events to. Also known as the Measurement ID, or the "G-ID" (For example: G-12345).
- },
- ],
-}
-list_next()
Retrieves the next page of results. @@ -1071,31 +926,6 @@Method Details
}
setAutomatedGa4ConfigurationOptOut(body=None, x__xgafv=None)
- Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.
-
-Args:
- body: object, The request body.
- The object takes the form of:
-
-{ # Request for setting the opt out status for the automated GA4 setup process.
- "optOut": True or False, # The status to set.
- "property": "A String", # Required. The UA property to set the opt out status. Note this request uses the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format: properties/{internalWebPropertyId} Example: properties/1234
-}
-
- 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 setting the opt out status for the automated GA4 setup process.
-}
-updateAttributionSettings(name, body=None, updateMask=None, x__xgafv=None)
Updates attribution settings on a property. 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 f8804265317..594363791ff 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html @@ -956,7 +956,7 @@Method Details
}, "deletionProtection": True or False, # Optional. Whether the resource should be protected against deletion. "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource. - "disks": [ # Optional. Array of disks associated with this instance. Persistent disks must be created before you can assign them. + "disks": [ # Optional. Array of disks associated with this instance. Persistent disks must be created before you can assign them. Source regional persistent disks will be restored with default replica zones if not specified. { # An instance-attached disk resource. "autoDelete": True or False, # Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). "boot": True or False, # Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. @@ -1024,7 +1024,7 @@Method Details
}, "minCpuPlatform": "A String", # Optional. Minimum CPU platform to use for this instance. "name": "A String", # Required. Name of the compute instance. - "networkInterfaces": [ # Optional. An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. + "networkInterfaces": [ # Optional. An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. Required to restore in different project or region. { # A network interface resource attached to an instance. s "accessConfigs": [ # Optional. An array of configurations for this interface. Currently, only one access config,ONE_TO_ONE_NAT is supported. If there are no accessConfigs specified, then this instance will have no external internet access. { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. @@ -1085,7 +1085,7 @@Method Details
"A String", ], }, - "resourcePolicies": [ # Optional. Resource policies applied to this instance. + "resourcePolicies": [ # Optional. Resource policies applied to this instance. By default, no resource policies will be applied. "A String", ], "scheduling": { # Sets the scheduling options for an Instance. # Optional. Sets the scheduling options for this instance. diff --git a/docs/dyn/backupdr_v1.projects.locations.managementServers.html b/docs/dyn/backupdr_v1.projects.locations.managementServers.html index c8d1df06113..40d25af11a6 100644 --- a/docs/dyn/backupdr_v1.projects.locations.managementServers.html +++ b/docs/dyn/backupdr_v1.projects.locations.managementServers.html @@ -95,6 +95,9 @@Instance Methods
Retrieves the next page of results.
++
+msComplianceMetadata(parent, body=None, x__xgafv=None)Returns the Assured Workloads compliance metadata for a given project.
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.
@@ -398,6 +401,32 @@Method Details
msComplianceMetadata(parent, body=None, x__xgafv=None)
+ Returns the Assured Workloads compliance metadata for a given project.
+
+Args:
+ parent: string, Required. The project and location to be used to check CSS metadata for target project information, in the format 'projects/{project_id}/locations/{location}'. In Cloud BackupDR, locations map to Google Cloud regions, for example **us-central1**. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for GetMsComplianceMetadata
+ "projectId": "A String", # Required. The project id of the target project
+}
+
+ 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 GetMsComplianceMetadata
+ "isAssuredWorkload": True or False, # The ms compliance metadata of the target project, if the project is an assured workloads project, values will be true, otherwise false.
+}
+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/beyondcorp_v1.projects.locations.securityGateways.applications.html b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.applications.html index 6881cc6baf8..a4c69704b0b 100644 --- a/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.applications.html +++ b/docs/dyn/beyondcorp_v1.projects.locations.securityGateways.applications.html @@ -132,6 +132,18 @@Method Details
], "name": "A String", # Identifier. Name of the resource. "updateTime": "A String", # Output only. Timestamp when the resource was last modified. + "upstreams": [ # Optional. Which upstream resources to forward traffic to. + { # Which upstream resource to forward traffic to. + "egressPolicy": { # Routing policy information. # Optional. Routing policy information. + "regions": [ # Required. List of the regions where the application sends traffic. + "A String", + ], + }, + "network": { # Network to forward traffic to. # Network to forward traffic to. + "name": "A String", # Required. Network name is of the format: `projects/{project}/global/networks/{network} + }, + }, + ], } applicationId: string, Optional. User-settable Application resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter. @@ -229,6 +241,18 @@Method Details
], "name": "A String", # Identifier. Name of the resource. "updateTime": "A String", # Output only. Timestamp when the resource was last modified. + "upstreams": [ # Optional. Which upstream resources to forward traffic to. + { # Which upstream resource to forward traffic to. + "egressPolicy": { # Routing policy information. # Optional. Routing policy information. + "regions": [ # Required. List of the regions where the application sends traffic. + "A String", + ], + }, + "network": { # Network to forward traffic to. # Network to forward traffic to. + "name": "A String", # Required. Network name is of the format: `projects/{project}/global/networks/{network} + }, + }, + ], }
getConfig(projectId, jobId, body=None, x__xgafv=None)
Get encoded debug configuration for component. Not cacheable.
-
- getWorkerStacktraces(projectId, jobId, body=None, x__xgafv=None)
Get worker stacktraces from debug capture.
sendCapture(projectId, jobId, body=None, x__xgafv=None)
Send encoded debug capture data for component.
@@ -121,46 +118,6 @@getWorkerStacktraces(projectId, jobId, body=None, x__xgafv=None)
- Get worker stacktraces from debug capture.
-
-Args:
- projectId: string, The project id. (required)
- jobId: string, The job for which to get stacktraces. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # Request to get worker stacktraces from debug capture.
- "workerId": "A String", # The worker for which to get stacktraces. The returned stacktraces will be for the SDK harness running on this worker.
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Response to get worker stacktraces from debug capture.
- "sdks": [ # Repeated as unified worker may have multiple SDK processes.
- { # A structured representation of an SDK.
- "sdkId": "A String", # The SDK harness id.
- "stacks": [ # The stacktraces for the processes running on the SDK harness.
- { # A structuredstacktrace for a process running on the worker.
- "stackContent": "A String", # The raw stack trace.
- "threadCount": 42, # With java thread dumps we may get collapsed stacks e.g., N threads in stack "". Instead of having to copy over the same stack trace N times, this int field captures this.
- "threadName": "A String", # Thread name. For example, "CommitThread-0,10,main"
- "threadState": "A String", # The state of the thread. For example, "WAITING".
- "timestamp": "A String", # Timestamp at which the stack was captured.
- },
- ],
- },
- ],
-}
-sendCapture(projectId, jobId, body=None, x__xgafv=None)
Send encoded debug capture data for component. diff --git a/docs/dyn/dataflow_v1b3.projects.locations.jobs.debug.html b/docs/dyn/dataflow_v1b3.projects.locations.jobs.debug.html index 65b186dd16c..8b2d84d64b7 100644 --- a/docs/dyn/dataflow_v1b3.projects.locations.jobs.debug.html +++ b/docs/dyn/dataflow_v1b3.projects.locations.jobs.debug.html @@ -80,6 +80,9 @@Instance Methods
getConfig(projectId, location, jobId, body=None, x__xgafv=None)Get encoded debug configuration for component. Not cacheable.
++
+getWorkerStacktraces(projectId, location, jobId, body=None, x__xgafv=None)Get worker stacktraces from debug capture.
sendCapture(projectId, location, jobId, body=None, x__xgafv=None)Send encoded debug capture data for component.
@@ -119,6 +122,47 @@Method Details
}
getWorkerStacktraces(projectId, location, jobId, body=None, x__xgafv=None)
+ Get worker stacktraces from debug capture.
+
+Args:
+ projectId: string, The project id. (required)
+ location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. (required)
+ jobId: string, The job for which to get stacktraces. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request to get worker stacktraces from debug capture.
+ "workerId": "A String", # The worker for which to get stacktraces. The returned stacktraces will be for the SDK harness running on this worker.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response to get worker stacktraces from debug capture.
+ "sdks": [ # Repeated as unified worker may have multiple SDK processes.
+ { # A structured representation of an SDK.
+ "sdkId": "A String", # The SDK harness id.
+ "stacks": [ # The stacktraces for the processes running on the SDK harness.
+ { # A structuredstacktrace for a process running on the worker.
+ "stackContent": "A String", # The raw stack trace.
+ "threadCount": 42, # With java thread dumps we may get collapsed stacks e.g., N threads in stack "". Instead of having to copy over the same stack trace N times, this int field captures this.
+ "threadName": "A String", # Thread name. For example, "CommitThread-0,10,main"
+ "threadState": "A String", # The state of the thread. For example, "WAITING".
+ "timestamp": "A String", # Timestamp at which the stack was captured.
+ },
+ ],
+ },
+ ],
+}
+sendCapture(projectId, location, jobId, body=None, x__xgafv=None)
Send encoded debug capture data for component. diff --git a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entryLinks.html b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entryLinks.html index 694782efe6a..a3fadd9c319 100644 --- a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entryLinks.html +++ b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entryLinks.html @@ -103,7 +103,7 @@Method Details
{ # EntryLink represents a link between two Entries. "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, of the form: `projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id}. + "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. 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} @@ -126,7 +126,7 @@Method Details
{ # EntryLink represents a link between two Entries. "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, of the form: `projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id}. + "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. 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} @@ -155,7 +155,7 @@Method Details
{ # EntryLink represents a link between two Entries. "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, of the form: `projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id}. + "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. 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} @@ -184,7 +184,7 @@Method Details
{ # EntryLink represents a link between two Entries. "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, of the form: `projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id}. + "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. 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} diff --git a/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html b/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html index 1fefa0a5c6d..5adfcece8ee 100644 --- a/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html +++ b/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html @@ -189,6 +189,7 @@Method Details
"oracleSslConfig": { # Oracle SSL configuration information. # Optional. SSL configuration for the Oracle connection. "caCertificate": "A String", # Input only. PEM-encoded certificate of the CA that signed the source database server's certificate. "caCertificateSet": True or False, # Output only. Indicates whether the ca_certificate field has been set for this Connection-Profile. + "serverCertificateDistinguishedName": "A String", # Optional. The distinguished name (DN) mentioned in the server certificate. This corresponds to SSL_SERVER_CERT_DN sqlnet parameter. Refer https://docs.oracle.com/en/database/oracle/oracle-database/19/netrf/local-naming-parameters-in-tns-ora-file.html#GUID-70AB0695-A9AA-4A94-B141-4C605236EEB7 If this field is not provided, the DN matching is not enforced. }, "password": "A String", # Optional. Password for the Oracle ASM connection. Mutually exclusive with the `secret_manager_stored_password` field. "port": 42, # Required. Port for the Oracle ASM connection. @@ -198,6 +199,7 @@Method Details
"oracleSslConfig": { # Oracle SSL configuration information. # Optional. SSL configuration for the Oracle connection. "caCertificate": "A String", # Input only. PEM-encoded certificate of the CA that signed the source database server's certificate. "caCertificateSet": True or False, # Output only. Indicates whether the ca_certificate field has been set for this Connection-Profile. + "serverCertificateDistinguishedName": "A String", # Optional. The distinguished name (DN) mentioned in the server certificate. This corresponds to SSL_SERVER_CERT_DN sqlnet parameter. Refer https://docs.oracle.com/en/database/oracle/oracle-database/19/netrf/local-naming-parameters-in-tns-ora-file.html#GUID-70AB0695-A9AA-4A94-B141-4C605236EEB7 If this field is not provided, the DN matching is not enforced. }, "password": "A String", # Optional. Password for the Oracle connection. Mutually exclusive with the `secret_manager_stored_password` field. "port": 42, # Port for the Oracle connection, default value is 1521. @@ -215,9 +217,11 @@Method Details
"caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. "clientCertificate": "A String", # Required. Input only. PEM-encoded certificate used by the source database to authenticate the client identity (i.e., the Datastream's identity). This certificate is signed by either a root certificate trusted by the server or one or more intermediate certificates (which is stored with the leaf certificate) to link the this certificate to the trusted root certificate. "clientKey": "A String", # Optional. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream. + "serverCertificateHostname": "A String", # Optional. The hostname mentioned in the Subject or SAN extension of the server certificate. If this field is not provided, the hostname in the server certificate is not validated. }, "serverVerification": { # Message represents the option where Datastream will enforce the encryption and authenticate the server identity. ca_certificate must be set if user selects this option. # If this field is set, the communication will be encrypted with TLS encryption and the server identity will be authenticated. "caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. + "serverCertificateHostname": "A String", # Optional. The hostname mentioned in the Subject or SAN extension of the server certificate. If this field is not provided, the hostname in the server certificate is not validated. }, }, "username": "A String", # Required. Username for the PostgreSQL connection. @@ -410,6 +414,7 @@Method Details
"oracleSslConfig": { # Oracle SSL configuration information. # Optional. SSL configuration for the Oracle connection. "caCertificate": "A String", # Input only. PEM-encoded certificate of the CA that signed the source database server's certificate. "caCertificateSet": True or False, # Output only. Indicates whether the ca_certificate field has been set for this Connection-Profile. + "serverCertificateDistinguishedName": "A String", # Optional. The distinguished name (DN) mentioned in the server certificate. This corresponds to SSL_SERVER_CERT_DN sqlnet parameter. Refer https://docs.oracle.com/en/database/oracle/oracle-database/19/netrf/local-naming-parameters-in-tns-ora-file.html#GUID-70AB0695-A9AA-4A94-B141-4C605236EEB7 If this field is not provided, the DN matching is not enforced. }, "password": "A String", # Optional. Password for the Oracle ASM connection. Mutually exclusive with the `secret_manager_stored_password` field. "port": 42, # Required. Port for the Oracle ASM connection. @@ -419,6 +424,7 @@Method Details
"oracleSslConfig": { # Oracle SSL configuration information. # Optional. SSL configuration for the Oracle connection. "caCertificate": "A String", # Input only. PEM-encoded certificate of the CA that signed the source database server's certificate. "caCertificateSet": True or False, # Output only. Indicates whether the ca_certificate field has been set for this Connection-Profile. + "serverCertificateDistinguishedName": "A String", # Optional. The distinguished name (DN) mentioned in the server certificate. This corresponds to SSL_SERVER_CERT_DN sqlnet parameter. Refer https://docs.oracle.com/en/database/oracle/oracle-database/19/netrf/local-naming-parameters-in-tns-ora-file.html#GUID-70AB0695-A9AA-4A94-B141-4C605236EEB7 If this field is not provided, the DN matching is not enforced. }, "password": "A String", # Optional. Password for the Oracle connection. Mutually exclusive with the `secret_manager_stored_password` field. "port": 42, # Port for the Oracle connection, default value is 1521. @@ -436,9 +442,11 @@Method Details
"caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. "clientCertificate": "A String", # Required. Input only. PEM-encoded certificate used by the source database to authenticate the client identity (i.e., the Datastream's identity). This certificate is signed by either a root certificate trusted by the server or one or more intermediate certificates (which is stored with the leaf certificate) to link the this certificate to the trusted root certificate. "clientKey": "A String", # Optional. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream. + "serverCertificateHostname": "A String", # Optional. The hostname mentioned in the Subject or SAN extension of the server certificate. If this field is not provided, the hostname in the server certificate is not validated. }, "serverVerification": { # Message represents the option where Datastream will enforce the encryption and authenticate the server identity. ca_certificate must be set if user selects this option. # If this field is set, the communication will be encrypted with TLS encryption and the server identity will be authenticated. "caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. + "serverCertificateHostname": "A String", # Optional. The hostname mentioned in the Subject or SAN extension of the server certificate. If this field is not provided, the hostname in the server certificate is not validated. }, }, "username": "A String", # Required. Username for the PostgreSQL connection. @@ -840,6 +848,7 @@Method Details
"oracleSslConfig": { # Oracle SSL configuration information. # Optional. SSL configuration for the Oracle connection. "caCertificate": "A String", # Input only. PEM-encoded certificate of the CA that signed the source database server's certificate. "caCertificateSet": True or False, # Output only. Indicates whether the ca_certificate field has been set for this Connection-Profile. + "serverCertificateDistinguishedName": "A String", # Optional. The distinguished name (DN) mentioned in the server certificate. This corresponds to SSL_SERVER_CERT_DN sqlnet parameter. Refer https://docs.oracle.com/en/database/oracle/oracle-database/19/netrf/local-naming-parameters-in-tns-ora-file.html#GUID-70AB0695-A9AA-4A94-B141-4C605236EEB7 If this field is not provided, the DN matching is not enforced. }, "password": "A String", # Optional. Password for the Oracle ASM connection. Mutually exclusive with the `secret_manager_stored_password` field. "port": 42, # Required. Port for the Oracle ASM connection. @@ -849,6 +858,7 @@Method Details
"oracleSslConfig": { # Oracle SSL configuration information. # Optional. SSL configuration for the Oracle connection. "caCertificate": "A String", # Input only. PEM-encoded certificate of the CA that signed the source database server's certificate. "caCertificateSet": True or False, # Output only. Indicates whether the ca_certificate field has been set for this Connection-Profile. + "serverCertificateDistinguishedName": "A String", # Optional. The distinguished name (DN) mentioned in the server certificate. This corresponds to SSL_SERVER_CERT_DN sqlnet parameter. Refer https://docs.oracle.com/en/database/oracle/oracle-database/19/netrf/local-naming-parameters-in-tns-ora-file.html#GUID-70AB0695-A9AA-4A94-B141-4C605236EEB7 If this field is not provided, the DN matching is not enforced. }, "password": "A String", # Optional. Password for the Oracle connection. Mutually exclusive with the `secret_manager_stored_password` field. "port": 42, # Port for the Oracle connection, default value is 1521. @@ -866,9 +876,11 @@Method Details
"caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. "clientCertificate": "A String", # Required. Input only. PEM-encoded certificate used by the source database to authenticate the client identity (i.e., the Datastream's identity). This certificate is signed by either a root certificate trusted by the server or one or more intermediate certificates (which is stored with the leaf certificate) to link the this certificate to the trusted root certificate. "clientKey": "A String", # Optional. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream. + "serverCertificateHostname": "A String", # Optional. The hostname mentioned in the Subject or SAN extension of the server certificate. If this field is not provided, the hostname in the server certificate is not validated. }, "serverVerification": { # Message represents the option where Datastream will enforce the encryption and authenticate the server identity. ca_certificate must be set if user selects this option. # If this field is set, the communication will be encrypted with TLS encryption and the server identity will be authenticated. "caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. + "serverCertificateHostname": "A String", # Optional. The hostname mentioned in the Subject or SAN extension of the server certificate. If this field is not provided, the hostname in the server certificate is not validated. }, }, "username": "A String", # Required. Username for the PostgreSQL connection. @@ -1003,6 +1015,7 @@Method Details
"oracleSslConfig": { # Oracle SSL configuration information. # Optional. SSL configuration for the Oracle connection. "caCertificate": "A String", # Input only. PEM-encoded certificate of the CA that signed the source database server's certificate. "caCertificateSet": True or False, # Output only. Indicates whether the ca_certificate field has been set for this Connection-Profile. + "serverCertificateDistinguishedName": "A String", # Optional. The distinguished name (DN) mentioned in the server certificate. This corresponds to SSL_SERVER_CERT_DN sqlnet parameter. Refer https://docs.oracle.com/en/database/oracle/oracle-database/19/netrf/local-naming-parameters-in-tns-ora-file.html#GUID-70AB0695-A9AA-4A94-B141-4C605236EEB7 If this field is not provided, the DN matching is not enforced. }, "password": "A String", # Optional. Password for the Oracle ASM connection. Mutually exclusive with the `secret_manager_stored_password` field. "port": 42, # Required. Port for the Oracle ASM connection. @@ -1012,6 +1025,7 @@Method Details
"oracleSslConfig": { # Oracle SSL configuration information. # Optional. SSL configuration for the Oracle connection. "caCertificate": "A String", # Input only. PEM-encoded certificate of the CA that signed the source database server's certificate. "caCertificateSet": True or False, # Output only. Indicates whether the ca_certificate field has been set for this Connection-Profile. + "serverCertificateDistinguishedName": "A String", # Optional. The distinguished name (DN) mentioned in the server certificate. This corresponds to SSL_SERVER_CERT_DN sqlnet parameter. Refer https://docs.oracle.com/en/database/oracle/oracle-database/19/netrf/local-naming-parameters-in-tns-ora-file.html#GUID-70AB0695-A9AA-4A94-B141-4C605236EEB7 If this field is not provided, the DN matching is not enforced. }, "password": "A String", # Optional. Password for the Oracle connection. Mutually exclusive with the `secret_manager_stored_password` field. "port": 42, # Port for the Oracle connection, default value is 1521. @@ -1029,9 +1043,11 @@Method Details
"caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. "clientCertificate": "A String", # Required. Input only. PEM-encoded certificate used by the source database to authenticate the client identity (i.e., the Datastream's identity). This certificate is signed by either a root certificate trusted by the server or one or more intermediate certificates (which is stored with the leaf certificate) to link the this certificate to the trusted root certificate. "clientKey": "A String", # Optional. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream. + "serverCertificateHostname": "A String", # Optional. The hostname mentioned in the Subject or SAN extension of the server certificate. If this field is not provided, the hostname in the server certificate is not validated. }, "serverVerification": { # Message represents the option where Datastream will enforce the encryption and authenticate the server identity. ca_certificate must be set if user selects this option. # If this field is set, the communication will be encrypted with TLS encryption and the server identity will be authenticated. "caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. + "serverCertificateHostname": "A String", # Optional. The hostname mentioned in the Subject or SAN extension of the server certificate. If this field is not provided, the hostname in the server certificate is not validated. }, }, "username": "A String", # Required. Username for the PostgreSQL connection. @@ -1175,6 +1191,7 @@Method Details
"oracleSslConfig": { # Oracle SSL configuration information. # Optional. SSL configuration for the Oracle connection. "caCertificate": "A String", # Input only. PEM-encoded certificate of the CA that signed the source database server's certificate. "caCertificateSet": True or False, # Output only. Indicates whether the ca_certificate field has been set for this Connection-Profile. + "serverCertificateDistinguishedName": "A String", # Optional. The distinguished name (DN) mentioned in the server certificate. This corresponds to SSL_SERVER_CERT_DN sqlnet parameter. Refer https://docs.oracle.com/en/database/oracle/oracle-database/19/netrf/local-naming-parameters-in-tns-ora-file.html#GUID-70AB0695-A9AA-4A94-B141-4C605236EEB7 If this field is not provided, the DN matching is not enforced. }, "password": "A String", # Optional. Password for the Oracle ASM connection. Mutually exclusive with the `secret_manager_stored_password` field. "port": 42, # Required. Port for the Oracle ASM connection. @@ -1184,6 +1201,7 @@Method Details
"oracleSslConfig": { # Oracle SSL configuration information. # Optional. SSL configuration for the Oracle connection. "caCertificate": "A String", # Input only. PEM-encoded certificate of the CA that signed the source database server's certificate. "caCertificateSet": True or False, # Output only. Indicates whether the ca_certificate field has been set for this Connection-Profile. + "serverCertificateDistinguishedName": "A String", # Optional. The distinguished name (DN) mentioned in the server certificate. This corresponds to SSL_SERVER_CERT_DN sqlnet parameter. Refer https://docs.oracle.com/en/database/oracle/oracle-database/19/netrf/local-naming-parameters-in-tns-ora-file.html#GUID-70AB0695-A9AA-4A94-B141-4C605236EEB7 If this field is not provided, the DN matching is not enforced. }, "password": "A String", # Optional. Password for the Oracle connection. Mutually exclusive with the `secret_manager_stored_password` field. "port": 42, # Port for the Oracle connection, default value is 1521. @@ -1201,9 +1219,11 @@Method Details
"caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. "clientCertificate": "A String", # Required. Input only. PEM-encoded certificate used by the source database to authenticate the client identity (i.e., the Datastream's identity). This certificate is signed by either a root certificate trusted by the server or one or more intermediate certificates (which is stored with the leaf certificate) to link the this certificate to the trusted root certificate. "clientKey": "A String", # Optional. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream. + "serverCertificateHostname": "A String", # Optional. The hostname mentioned in the Subject or SAN extension of the server certificate. If this field is not provided, the hostname in the server certificate is not validated. }, "serverVerification": { # Message represents the option where Datastream will enforce the encryption and authenticate the server identity. ca_certificate must be set if user selects this option. # If this field is set, the communication will be encrypted with TLS encryption and the server identity will be authenticated. "caCertificate": "A String", # Required. Input only. PEM-encoded server root CA certificate. + "serverCertificateHostname": "A String", # Optional. The hostname mentioned in the Subject or SAN extension of the server certificate. If this field is not provided, the hostname in the server certificate is not validated. }, }, "username": "A String", # Required. Username for the PostgreSQL connection. diff --git a/docs/dyn/developerconnect_v1.projects.locations.insightsConfigs.html b/docs/dyn/developerconnect_v1.projects.locations.insightsConfigs.html index 82bdcfe714f..77fa1430a1e 100644 --- a/docs/dyn/developerconnect_v1.projects.locations.insightsConfigs.html +++ b/docs/dyn/developerconnect_v1.projects.locations.insightsConfigs.html @@ -120,7 +120,7 @@Method Details
"googleArtifactAnalysis": { # Google Artifact Analysis configurations. # Optional. Set if the artifact metadata is stored in Artifact analysis. "projectId": "A String", # Required. The project id of the project where the provenance is stored. }, - "googleArtifactRegistry": { # Google Artifact Registry configurations. # Optional. Set if the artifact is stored in Artifact regsitry. + "googleArtifactRegistry": { # Google Artifact Registry configurations. # Optional. Set if the artifact is stored in Artifact registry. "artifactRegistryPackage": "A String", # Required. Immutable. The name of the artifact registry package. "projectId": "A String", # Required. The host project of Artifact Registry. }, @@ -256,7 +256,7 @@Method Details
"googleArtifactAnalysis": { # Google Artifact Analysis configurations. # Optional. Set if the artifact metadata is stored in Artifact analysis. "projectId": "A String", # Required. The project id of the project where the provenance is stored. }, - "googleArtifactRegistry": { # Google Artifact Registry configurations. # Optional. Set if the artifact is stored in Artifact regsitry. + "googleArtifactRegistry": { # Google Artifact Registry configurations. # Optional. Set if the artifact is stored in Artifact registry. "artifactRegistryPackage": "A String", # Required. Immutable. The name of the artifact registry package. "projectId": "A String", # Required. The host project of Artifact Registry. }, @@ -330,7 +330,7 @@Method Details
"googleArtifactAnalysis": { # Google Artifact Analysis configurations. # Optional. Set if the artifact metadata is stored in Artifact analysis. "projectId": "A String", # Required. The project id of the project where the provenance is stored. }, - "googleArtifactRegistry": { # Google Artifact Registry configurations. # Optional. Set if the artifact is stored in Artifact regsitry. + "googleArtifactRegistry": { # Google Artifact Registry configurations. # Optional. Set if the artifact is stored in Artifact registry. "artifactRegistryPackage": "A String", # Required. Immutable. The name of the artifact registry package. "projectId": "A String", # Required. The host project of Artifact Registry. }, @@ -413,7 +413,7 @@Method Details
"googleArtifactAnalysis": { # Google Artifact Analysis configurations. # Optional. Set if the artifact metadata is stored in Artifact analysis. "projectId": "A String", # Required. The project id of the project where the provenance is stored. }, - "googleArtifactRegistry": { # Google Artifact Registry configurations. # Optional. Set if the artifact is stored in Artifact regsitry. + "googleArtifactRegistry": { # Google Artifact Registry configurations. # Optional. Set if the artifact is stored in Artifact registry. "artifactRegistryPackage": "A String", # Required. Immutable. The name of the artifact registry package. "projectId": "A String", # Required. The host project of Artifact Registry. }, diff --git a/docs/dyn/dialogflow_v2.projects.locations.html b/docs/dyn/dialogflow_v2.projects.locations.html index 21981347f6f..4b2df8ae12e 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.html +++ b/docs/dyn/dialogflow_v2.projects.locations.html @@ -124,6 +124,11 @@Instance Methods
Returns the operations Resource.
++
+sipTrunks()+Returns the sipTrunks Resource.
+ diff --git a/docs/dyn/dialogflow_v2.projects.locations.sipTrunks.html b/docs/dyn/dialogflow_v2.projects.locations.sipTrunks.html new file mode 100644 index 00000000000..255364704ba --- /dev/null +++ b/docs/dyn/dialogflow_v2.projects.locations.sipTrunks.html @@ -0,0 +1,324 @@ + + + +Dialogflow API . projects . locations . sipTrunks
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(parent, body=None, x__xgafv=None)Creates a SipTrunk for a specified location.
+ +Deletes a specified SipTrunk.
+ +Retrieves the specified SipTrunk.
++
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)Returns a list of SipTrunks in the specified location.
+ +Retrieves the next page of results.
++
+patch(name, body=None, updateMask=None, x__xgafv=None)Updates the specified SipTrunk.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(parent, body=None, x__xgafv=None)+Creates a SipTrunk for a specified location. + +Args: + parent: string, Required. The location to create a SIP trunk for. Format: `projects//locations/`. (required) + body: object, The request body. + The object takes the form of: + +{ # SipTrunk is the resource that represents a SIP trunk to connect to Google Telephony platform SIP trunking service. + "connections": [ # Output only. Connections of the SIP trunk. + { # Represents a connection for SIP Trunk. + "connectionId": "A String", # Output only. The unique identifier of the SIP Trunk connection. + "errorDetails": { # The error details of Sip Trunk connection authentication. # Output only. The error details for the connection. Only populated when authentication errors occur. + "certificateState": "A String", # Output only. The status of the certificate authentication. + "errorMessage": "A String", # The error message provided from SIP trunking auth service + }, + "state": "A String", # Output only. State of the connection. + "updateTime": "A String", # Output only. When the connection status changed. + }, + ], + "displayName": "A String", # Optional. Human readable alias for this trunk. + "expectedHostname": [ # Required. The expected hostnames in the peer certificate from partner that is used for TLS authentication. + "A String", + ], + "name": "A String", # Identifier. The unique identifier of the SIP trunk. Format: `projects//locations//sipTrunks/`. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # SipTrunk is the resource that represents a SIP trunk to connect to Google Telephony platform SIP trunking service. + "connections": [ # Output only. Connections of the SIP trunk. + { # Represents a connection for SIP Trunk. + "connectionId": "A String", # Output only. The unique identifier of the SIP Trunk connection. + "errorDetails": { # The error details of Sip Trunk connection authentication. # Output only. The error details for the connection. Only populated when authentication errors occur. + "certificateState": "A String", # Output only. The status of the certificate authentication. + "errorMessage": "A String", # The error message provided from SIP trunking auth service + }, + "state": "A String", # Output only. State of the connection. + "updateTime": "A String", # Output only. When the connection status changed. + }, + ], + "displayName": "A String", # Optional. Human readable alias for this trunk. + "expectedHostname": [ # Required. The expected hostnames in the peer certificate from partner that is used for TLS authentication. + "A String", + ], + "name": "A String", # Identifier. The unique identifier of the SIP trunk. Format: `projects//locations//sipTrunks/`. +}+++ +delete(name, x__xgafv=None)+Deletes a specified SipTrunk. + +Args: + name: string, Required. The name of the SIP trunk to delete. Format: `projects//locations//sipTrunks/`. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } +}+++ +get(name, x__xgafv=None)+Retrieves the specified SipTrunk. + +Args: + name: string, Required. The name of the SIP trunk to delete. Format: `projects//locations//sipTrunks/`. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # SipTrunk is the resource that represents a SIP trunk to connect to Google Telephony platform SIP trunking service. + "connections": [ # Output only. Connections of the SIP trunk. + { # Represents a connection for SIP Trunk. + "connectionId": "A String", # Output only. The unique identifier of the SIP Trunk connection. + "errorDetails": { # The error details of Sip Trunk connection authentication. # Output only. The error details for the connection. Only populated when authentication errors occur. + "certificateState": "A String", # Output only. The status of the certificate authentication. + "errorMessage": "A String", # The error message provided from SIP trunking auth service + }, + "state": "A String", # Output only. State of the connection. + "updateTime": "A String", # Output only. When the connection status changed. + }, + ], + "displayName": "A String", # Optional. Human readable alias for this trunk. + "expectedHostname": [ # Required. The expected hostnames in the peer certificate from partner that is used for TLS authentication. + "A String", + ], + "name": "A String", # Identifier. The unique identifier of the SIP trunk. Format: `projects//locations//sipTrunks/`. +}+++ +list(parent, pageSize=None, pageToken=None, x__xgafv=None)+Returns a list of SipTrunks in the specified location. + +Args: + parent: string, Required. The location to list SIP trunks from. Format: `projects//locations/`. (required) + pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. + pageToken: string, Optional. The next_page_token value returned from a previous list request. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # The response message for SipTrunks.ListSipTrunks. + "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. + "sipTrunks": [ # The list of SIP trunks. + { # SipTrunk is the resource that represents a SIP trunk to connect to Google Telephony platform SIP trunking service. + "connections": [ # Output only. Connections of the SIP trunk. + { # Represents a connection for SIP Trunk. + "connectionId": "A String", # Output only. The unique identifier of the SIP Trunk connection. + "errorDetails": { # The error details of Sip Trunk connection authentication. # Output only. The error details for the connection. Only populated when authentication errors occur. + "certificateState": "A String", # Output only. The status of the certificate authentication. + "errorMessage": "A String", # The error message provided from SIP trunking auth service + }, + "state": "A String", # Output only. State of the connection. + "updateTime": "A String", # Output only. When the connection status changed. + }, + ], + "displayName": "A String", # Optional. Human readable alias for this trunk. + "expectedHostname": [ # Required. The expected hostnames in the peer certificate from partner that is used for TLS authentication. + "A String", + ], + "name": "A String", # Identifier. The unique identifier of the SIP trunk. Format: `projects//locations//sipTrunks/`. + }, + ], +}+++ +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/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html index 6178ec47d43..fc58e700be8 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.branches.documents.html @@ -392,7 +392,7 @@patch(name, body=None, updateMask=None, x__xgafv=None)+Updates the specified SipTrunk. + +Args: + name: string, Identifier. The unique identifier of the SIP trunk. Format: `projects//locations//sipTrunks/`. (required) + body: object, The request body. + The object takes the form of: + +{ # SipTrunk is the resource that represents a SIP trunk to connect to Google Telephony platform SIP trunking service. + "connections": [ # Output only. Connections of the SIP trunk. + { # Represents a connection for SIP Trunk. + "connectionId": "A String", # Output only. The unique identifier of the SIP Trunk connection. + "errorDetails": { # The error details of Sip Trunk connection authentication. # Output only. The error details for the connection. Only populated when authentication errors occur. + "certificateState": "A String", # Output only. The status of the certificate authentication. + "errorMessage": "A String", # The error message provided from SIP trunking auth service + }, + "state": "A String", # Output only. State of the connection. + "updateTime": "A String", # Output only. When the connection status changed. + }, + ], + "displayName": "A String", # Optional. Human readable alias for this trunk. + "expectedHostname": [ # Required. The expected hostnames in the peer certificate from partner that is used for TLS authentication. + "A String", + ], + "name": "A String", # Identifier. The unique identifier of the SIP trunk. Format: `projects//locations//sipTrunks/`. +} + + updateMask: string, Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # SipTrunk is the resource that represents a SIP trunk to connect to Google Telephony platform SIP trunking service. + "connections": [ # Output only. Connections of the SIP trunk. + { # Represents a connection for SIP Trunk. + "connectionId": "A String", # Output only. The unique identifier of the SIP Trunk connection. + "errorDetails": { # The error details of Sip Trunk connection authentication. # Output only. The error details for the connection. Only populated when authentication errors occur. + "certificateState": "A String", # Output only. The status of the certificate authentication. + "errorMessage": "A String", # The error message provided from SIP trunking auth service + }, + "state": "A String", # Output only. State of the connection. + "updateTime": "A String", # Output only. When the connection status changed. + }, + ], + "displayName": "A String", # Optional. Human readable alias for this trunk. + "expectedHostname": [ # Required. The expected hostnames in the peer certificate from partner that is used for TLS authentication. + "A String", + ], + "name": "A String", # Identifier. The unique identifier of the SIP trunk. Format: `projects//locations//sipTrunks/`. +}+Method Details
"A String", ], }, - "idField": "A String", # The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. + "idField": "A String", # The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * BigtableSource. "inlineSource": { # The inline source for the input config for ImportDocuments method. # The Inline source for the input content for documents. "documents": [ # Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. { # Document captures all raw metadata information of items to be recommended or searched. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionConfig.html new file mode 100644 index 00000000000..67be70e9003 --- /dev/null +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionConfig.html @@ -0,0 +1,278 @@ + + + +Discovery Engine API . projects . locations . collections . dataStores . completionConfig
+Instance Methods
++
+close()Close httplib2 connections.
++
+completeQuery(completionConfig, body=None, x__xgafv=None)Completes the user input with advanced keyword suggestions.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html index 3eaf5786bb2..ccf727bcab3 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html @@ -79,6 +79,11 @@completeQuery(completionConfig, body=None, x__xgafv=None)+Completes the user input with advanced keyword suggestions. + +Args: + completionConfig: string, Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`. (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for CompletionService.AdvancedCompleteQuery method. . + "boostSpec": { # Specification to boost suggestions based on the condtion of the suggestion. # Optional. Specification to boost suggestions matching the condition. + "conditionBoostSpecs": [ # Condition boost specifications. If a suggestion matches multiple conditions in the specifications, boost values from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. Note: Currently only support language condition boost. + { # Boost applies to suggestions which match a condition. + "boost": 3.14, # Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored. + "condition": "A String", # An expression which specifies a boost condition. The syntax is the same as [filter expression syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax). Currently, the only supported condition is a list of BCP-47 lang codes. Example: * To boost suggestions in languages `en` or `fr`: `(lang_code: ANY("en", "fr"))` + }, + ], + }, + "experimentIds": [ # Optional. Experiment ids for this request. + "A String", + ], + "includeTailSuggestions": True or False, # Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. + "query": "A String", # Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query. + "queryModel": "A String", # Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. + "suggestionTypeSpecs": [ # Optional. Specification of each suggestion type. + { # Specification of each suggestion type. + "maxSuggestions": 42, # Optional. Maximum number of suggestions to return for each suggestion type. + "suggestionType": "A String", # Optional. Suggestion type. + }, + ], + "suggestionTypes": [ # Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment. + "A String", + ], + "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. + "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. + "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + }, + "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response message for CompletionService.AdvancedCompleteQuery method. + "contentSuggestions": [ # Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion. + { # Suggestions as content. + "contentType": "A String", # The type of the content suggestion. + "dataStore": "A String", # The name of the dataStore that this suggestion belongs to. + "destinationUri": "A String", # The destination uri of the content suggestion. + "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the suggestion. Only a subset of fields will be populated. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ # Readers of the document. + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "idpWide": True or False, # All users within the Identity Provider. + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, + "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store. + "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml. + "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. + "uri": "A String", # The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 200 MB for other formats. + }, + "derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, if document's index is in progress, the pending_message field is populated. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # 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). + "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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + "pendingMessage": "A String", # Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending. + }, + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. + "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "schemaId": "A String", # The identifier of the schema located in the same data store. + "structData": { # The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "a_key": "", # Properties of the object. + }, + }, + "iconUri": "A String", # The icon uri of the content suggestion. + "score": 3.14, # The score of each suggestion. The score is in the range of [0, 1]. + "suggestion": "A String", # The suggestion for the query. + }, + ], + "peopleSuggestions": [ # Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion. + { # Suggestions as people. + "dataStore": "A String", # The name of the dataStore that this suggestion belongs to. + "destinationUri": "A String", # The destination uri of the person suggestion. + "displayPhotoUri": "A String", # The photo uri of the person suggestion. + "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the suggestion. Only a subset of fields is populated. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ # Readers of the document. + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "idpWide": True or False, # All users within the Identity Provider. + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, + "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store. + "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml. + "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. + "uri": "A String", # The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 200 MB for other formats. + }, + "derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, if document's index is in progress, the pending_message field is populated. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # 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). + "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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + "pendingMessage": "A String", # Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending. + }, + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. + "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "schemaId": "A String", # The identifier of the schema located in the same data store. + "structData": { # The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "a_key": "", # Properties of the object. + }, + }, + "personType": "A String", # The type of the person. + "score": 3.14, # The score of each suggestion. The score is in the range of [0, 1]. + "suggestion": "A String", # The suggestion for the query. + }, + ], + "querySuggestions": [ # Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. + { # Suggestions as search queries. + "completableFieldPaths": [ # The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model. + "A String", + ], + "dataStore": [ # The name of the dataStore that this suggestion belongs to. + "A String", + ], + "score": 3.14, # The score of each suggestion. The score is in the range of [0, 1]. + "suggestion": "A String", # The suggestion for the query. + }, + ], + "recentSearchSuggestions": [ # Results of the matched "recent search" suggestions. The result list is ordered and the first result is the top suggestion. + { # Suggestions from recent search history. + "recentSearchTime": "A String", # The time when this recent rearch happened. + "score": 3.14, # The score of each suggestion. The score is in the range of [0, 1]. + "suggestion": "A String", # The suggestion for the query. + }, + ], + "tailMatchTriggered": True or False, # True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query. +}+Instance Methods
Returns the branches Resource.
+ +Returns the completionConfig Resource.
+ @@ -258,6 +263,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -286,6 +292,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -466,6 +473,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -494,6 +502,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -630,6 +639,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -658,6 +668,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -782,6 +793,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -810,6 +822,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -916,6 +929,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -944,6 +958,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. 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 2d3e8bf235e..16577f51f62 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -1148,7 +1148,7 @@Method Details
"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. @@ -1518,7 +1518,7 @@Method Details
"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html new file mode 100644 index 00000000000..c3a5195cd9f --- /dev/null +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html @@ -0,0 +1,226 @@ + + + +Discovery Engine API . projects . locations . collections . engines . assistants
+Instance Methods
++
+close()Close httplib2 connections.
++
+streamAssist(name, body=None, x__xgafv=None)Assists the user with a query in a streaming fashion.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.completionConfig.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.completionConfig.html new file mode 100644 index 00000000000..9bf2e3d22cf --- /dev/null +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.completionConfig.html @@ -0,0 +1,278 @@ + + + +streamAssist(name, body=None, x__xgafv=None)+Assists the user with a query in a streaming fashion. + +Args: + name: string, Required. The resource name of the Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` (required) + body: object, The request body. + The object takes the form of: + +{ # Request for the AssistantService.StreamAssist method. + "generationSpec": { # Assistant generation specification for the request. This allows to override the default generation configuration at the engine level. # Optional. Specification of the generation configuration for the request. + "modelId": "A String", # Optional. The Vertex AI model_id used for the generative model. If not set, the default Assistant model will be used. + }, + "query": { # Defines a user inputed query. # Optional. Current user query. Empty query is only supported if `file_ids` are provided. In this case, the answer will be generated based on those context files. + "queryId": "A String", # Output only. Unique Id for the query. + "text": "A String", # Plain text. + }, + "session": "A String", # Optional. The session to use for the request. If specified, the assistant has access to the session history, and the query and the answer are stored there. If `-` is specified as the session ID, or it is left empty, then a new session is created with an automatically generated ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` + "toolsSpec": { # Specification of tools that are used to serve the request. # Optional. Specification of tools that are used to serve the request. + "imageGenerationSpec": { # Specification of the image generation tool. # Optional. Specification of the image generation tool. + }, + "toolRegistry": "A String", # Optional. The name of the tool registry to use. Format: `projects/{project}/locations/{location}/toolRegistries/{tool_registry}` + "vertexAiSearchSpec": { # Specification of the Vertex AI Search tool. # Optional. Specification of the Vertex AI Search tool. + "dataStoreSpecs": [ # Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. + { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. + "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) + "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. + { # Boost applies to documents which match a condition. + "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable). + "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below. + }, + "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` + }, + ], + }, + "customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). + "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "disabled": True or False, # Optional. Deprecated. Please refrain from using this field. Whether the Vertex AI Search tool is disabled. Default value is false, the tool is enabled by default. + "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + "videoGenerationSpec": { # Specification of the video generation tool. # Optional. Specification of the video generation tool. + }, + "webGroundingSpec": { # Specification of the web grounding tool. # Optional. Specification of the web grounding tool. If field is present, enables grounding with web search. Works only if Assistant.web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. + "enabled": True or False, # Optional. Deprecated. Please refrain from using this field. Whether the web grounding tool is enabled. + }, + }, + "userMetadata": { # User metadata of the request. # Optional. Information about the user initiating the query. + "preferredLanguageCode": "A String", # Optional. Preferred language to be used for answering if language detection fails. Also used as the language of error messages created by actions, regardless of language detection results. + "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. + }, +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response for the AssistantService.StreamAssist method. + "answer": { # AssistAnswer resource, main part of AssistResponse. # Assist answer resource object containing parts of the assistant's final answer for the user's query. Not present if the current response doesn't add anything to previously sent AssistAnswer.replies. Observe AssistAnswer.state to see if more parts are to be expected. While the state is `IN_PROGRESS`, the AssistAnswer.replies field in each response will contain replies (reply fragments) to be appended to the ones received in previous responses. AssistAnswer.name won't be filled. If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response is the last response and AssistAnswer.name will have a value. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, + "assistToken": "A String", # A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support. + "sessionInfo": { # Information about the session. # Session information. + "session": "A String", # Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`. + }, +}+Discovery Engine API . projects . locations . collections . engines . completionConfig
+Instance Methods
++
+close()Close httplib2 connections.
++
+completeQuery(completionConfig, body=None, x__xgafv=None)Completes the user input with advanced keyword suggestions.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html index 597471befe5..001f7facd1f 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html @@ -74,6 +74,16 @@completeQuery(completionConfig, body=None, x__xgafv=None)+Completes the user input with advanced keyword suggestions. + +Args: + completionConfig: string, Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`. (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for CompletionService.AdvancedCompleteQuery method. . + "boostSpec": { # Specification to boost suggestions based on the condtion of the suggestion. # Optional. Specification to boost suggestions matching the condition. + "conditionBoostSpecs": [ # Condition boost specifications. If a suggestion matches multiple conditions in the specifications, boost values from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. Note: Currently only support language condition boost. + { # Boost applies to suggestions which match a condition. + "boost": 3.14, # Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored. + "condition": "A String", # An expression which specifies a boost condition. The syntax is the same as [filter expression syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax). Currently, the only supported condition is a list of BCP-47 lang codes. Example: * To boost suggestions in languages `en` or `fr`: `(lang_code: ANY("en", "fr"))` + }, + ], + }, + "experimentIds": [ # Optional. Experiment ids for this request. + "A String", + ], + "includeTailSuggestions": True or False, # Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. + "query": "A String", # Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query. + "queryModel": "A String", # Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. + "suggestionTypeSpecs": [ # Optional. Specification of each suggestion type. + { # Specification of each suggestion type. + "maxSuggestions": 42, # Optional. Maximum number of suggestions to return for each suggestion type. + "suggestionType": "A String", # Optional. Suggestion type. + }, + ], + "suggestionTypes": [ # Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment. + "A String", + ], + "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. + "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. + "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + }, + "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response message for CompletionService.AdvancedCompleteQuery method. + "contentSuggestions": [ # Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion. + { # Suggestions as content. + "contentType": "A String", # The type of the content suggestion. + "dataStore": "A String", # The name of the dataStore that this suggestion belongs to. + "destinationUri": "A String", # The destination uri of the content suggestion. + "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the suggestion. Only a subset of fields will be populated. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ # Readers of the document. + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "idpWide": True or False, # All users within the Identity Provider. + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, + "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store. + "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml. + "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. + "uri": "A String", # The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 200 MB for other formats. + }, + "derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, if document's index is in progress, the pending_message field is populated. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # 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). + "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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + "pendingMessage": "A String", # Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending. + }, + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. + "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "schemaId": "A String", # The identifier of the schema located in the same data store. + "structData": { # The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "a_key": "", # Properties of the object. + }, + }, + "iconUri": "A String", # The icon uri of the content suggestion. + "score": 3.14, # The score of each suggestion. The score is in the range of [0, 1]. + "suggestion": "A String", # The suggestion for the query. + }, + ], + "peopleSuggestions": [ # Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion. + { # Suggestions as people. + "dataStore": "A String", # The name of the dataStore that this suggestion belongs to. + "destinationUri": "A String", # The destination uri of the person suggestion. + "displayPhotoUri": "A String", # The photo uri of the person suggestion. + "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the suggestion. Only a subset of fields is populated. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ # Readers of the document. + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "idpWide": True or False, # All users within the Identity Provider. + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, + "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store. + "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml. + "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. + "uri": "A String", # The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 200 MB for other formats. + }, + "derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, if document's index is in progress, the pending_message field is populated. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # 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). + "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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + "pendingMessage": "A String", # Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending. + }, + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. + "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "schemaId": "A String", # The identifier of the schema located in the same data store. + "structData": { # The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "a_key": "", # Properties of the object. + }, + }, + "personType": "A String", # The type of the person. + "score": 3.14, # The score of each suggestion. The score is in the range of [0, 1]. + "suggestion": "A String", # The suggestion for the query. + }, + ], + "querySuggestions": [ # Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. + { # Suggestions as search queries. + "completableFieldPaths": [ # The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model. + "A String", + ], + "dataStore": [ # The name of the dataStore that this suggestion belongs to. + "A String", + ], + "score": 3.14, # The score of each suggestion. The score is in the range of [0, 1]. + "suggestion": "A String", # The suggestion for the query. + }, + ], + "recentSearchSuggestions": [ # Results of the matched "recent search" suggestions. The result list is ordered and the first result is the top suggestion. + { # Suggestions from recent search history. + "recentSearchTime": "A String", # The time when this recent rearch happened. + "score": 3.14, # The score of each suggestion. The score is in the range of [0, 1]. + "suggestion": "A String", # The suggestion for the query. + }, + ], + "tailMatchTriggered": True or False, # True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query. +}+Discovery Engine API . projects . locations . collections . engines
Instance Methods
++
+assistants()+Returns the assistants Resource.
+ + +Returns the completionConfig Resource.
+ @@ -158,7 +168,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -292,7 +302,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -367,7 +377,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -449,7 +459,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -513,7 +523,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html index 794df0aa7ac..874b8f746e1 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -1148,7 +1148,7 @@Method Details
"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. @@ -1518,7 +1518,7 @@Method Details
"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html index c213e240c07..92bb478231b 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.branches.documents.html @@ -392,7 +392,7 @@Method Details
"A String", ], }, - "idField": "A String", # The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. + "idField": "A String", # The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * BigtableSource. "inlineSource": { # The inline source for the input config for ImportDocuments method. # The Inline source for the input content for documents. "documents": [ # Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. { # Document captures all raw metadata information of items to be recommended or searched. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionConfig.html new file mode 100644 index 00000000000..74429d29e68 --- /dev/null +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionConfig.html @@ -0,0 +1,278 @@ + + + +Discovery Engine API . projects . locations . dataStores . completionConfig
+Instance Methods
++
+close()Close httplib2 connections.
++
+completeQuery(completionConfig, body=None, x__xgafv=None)Completes the user input with advanced keyword suggestions.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html index afdafa8881b..00b173d8fed 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html @@ -79,6 +79,11 @@completeQuery(completionConfig, body=None, x__xgafv=None)+Completes the user input with advanced keyword suggestions. + +Args: + completionConfig: string, Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`. (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for CompletionService.AdvancedCompleteQuery method. . + "boostSpec": { # Specification to boost suggestions based on the condtion of the suggestion. # Optional. Specification to boost suggestions matching the condition. + "conditionBoostSpecs": [ # Condition boost specifications. If a suggestion matches multiple conditions in the specifications, boost values from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. Note: Currently only support language condition boost. + { # Boost applies to suggestions which match a condition. + "boost": 3.14, # Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored. + "condition": "A String", # An expression which specifies a boost condition. The syntax is the same as [filter expression syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax). Currently, the only supported condition is a list of BCP-47 lang codes. Example: * To boost suggestions in languages `en` or `fr`: `(lang_code: ANY("en", "fr"))` + }, + ], + }, + "experimentIds": [ # Optional. Experiment ids for this request. + "A String", + ], + "includeTailSuggestions": True or False, # Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. + "query": "A String", # Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query. + "queryModel": "A String", # Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. + "suggestionTypeSpecs": [ # Optional. Specification of each suggestion type. + { # Specification of each suggestion type. + "maxSuggestions": 42, # Optional. Maximum number of suggestions to return for each suggestion type. + "suggestionType": "A String", # Optional. Suggestion type. + }, + ], + "suggestionTypes": [ # Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment. + "A String", + ], + "userInfo": { # Information of an end user. # Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. + "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. + "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. + "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + }, + "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response message for CompletionService.AdvancedCompleteQuery method. + "contentSuggestions": [ # Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion. + { # Suggestions as content. + "contentType": "A String", # The type of the content suggestion. + "dataStore": "A String", # The name of the dataStore that this suggestion belongs to. + "destinationUri": "A String", # The destination uri of the content suggestion. + "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the suggestion. Only a subset of fields will be populated. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ # Readers of the document. + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "idpWide": True or False, # All users within the Identity Provider. + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, + "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store. + "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml. + "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. + "uri": "A String", # The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 200 MB for other formats. + }, + "derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, if document's index is in progress, the pending_message field is populated. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # 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). + "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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + "pendingMessage": "A String", # Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending. + }, + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. + "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "schemaId": "A String", # The identifier of the schema located in the same data store. + "structData": { # The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "a_key": "", # Properties of the object. + }, + }, + "iconUri": "A String", # The icon uri of the content suggestion. + "score": 3.14, # The score of each suggestion. The score is in the range of [0, 1]. + "suggestion": "A String", # The suggestion for the query. + }, + ], + "peopleSuggestions": [ # Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion. + { # Suggestions as people. + "dataStore": "A String", # The name of the dataStore that this suggestion belongs to. + "destinationUri": "A String", # The destination uri of the person suggestion. + "displayPhotoUri": "A String", # The photo uri of the person suggestion. + "document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the suggestion. Only a subset of fields is populated. + "aclInfo": { # ACL Information of the Document. # Access control information for the document. + "readers": [ # Readers of the document. + { # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } } + "idpWide": True or False, # All users within the Identity Provider. + "principals": [ # List of principals. + { # Principal identifier of a user or a group. + "externalEntityId": "A String", # For 3P application identities which are not present in the customer identity provider. + "groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config. + "userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config. + }, + ], + }, + ], + }, + "content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content can only be set and must be set if this document is under a `CONTENT_REQUIRED` data store. + "mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml. + "rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. + "uri": "A String", # The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 200 MB for other formats. + }, + "derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. + "indexStatus": { # Index status of the document. # Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, if document's index is in progress, the pending_message field is populated. + "errorSamples": [ # A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + { # 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). + "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. + }, + ], + "indexTime": "A String", # The time when the document was indexed. If this field is populated, it means the document has been indexed. + "pendingMessage": "A String", # Immutable. The message indicates the document index is in progress. If this field is populated, the document index is pending. + }, + "indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. + "jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + "parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + "schemaId": "A String", # The identifier of the schema located in the same data store. + "structData": { # The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + "a_key": "", # Properties of the object. + }, + }, + "personType": "A String", # The type of the person. + "score": 3.14, # The score of each suggestion. The score is in the range of [0, 1]. + "suggestion": "A String", # The suggestion for the query. + }, + ], + "querySuggestions": [ # Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. + { # Suggestions as search queries. + "completableFieldPaths": [ # The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model. + "A String", + ], + "dataStore": [ # The name of the dataStore that this suggestion belongs to. + "A String", + ], + "score": 3.14, # The score of each suggestion. The score is in the range of [0, 1]. + "suggestion": "A String", # The suggestion for the query. + }, + ], + "recentSearchSuggestions": [ # Results of the matched "recent search" suggestions. The result list is ordered and the first result is the top suggestion. + { # Suggestions from recent search history. + "recentSearchTime": "A String", # The time when this recent rearch happened. + "score": 3.14, # The score of each suggestion. The score is in the range of [0, 1]. + "suggestion": "A String", # The suggestion for the query. + }, + ], + "tailMatchTriggered": True or False, # True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query. +}+Instance Methods
Returns the branches Resource.
+ +Returns the completionConfig Resource.
+ @@ -250,6 +255,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -278,6 +284,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -458,6 +465,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -486,6 +494,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -622,6 +631,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -650,6 +660,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -774,6 +785,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -802,6 +814,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -908,6 +921,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -936,6 +950,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index 644edc9db96..0887fcaefc9 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -1148,7 +1148,7 @@Method Details
"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. @@ -1518,7 +1518,7 @@Method Details
"searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html index 2cbcfa787dc..9791b064ebd 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.branches.documents.html @@ -432,7 +432,7 @@Method Details
"A String", ], }, - "idField": "A String", # The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. + "idField": "A String", # The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * BigtableSource. "inlineSource": { # The inline source for the input config for ImportDocuments method. # The Inline source for the input content for documents. "documents": [ # Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. { # Document captures all raw metadata information of items to be recommended or searched. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html index 90415ac4525..09fe04a6935 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html @@ -274,6 +274,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -302,6 +303,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -517,6 +519,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -545,6 +548,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -660,6 +664,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -688,6 +693,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -795,6 +801,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -823,6 +830,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -982,6 +990,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -1010,6 +1019,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -1151,6 +1161,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -1179,6 +1190,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -1341,6 +1353,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -1369,6 +1382,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -1414,6 +1428,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -1442,6 +1457,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. 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 97b62140429..b67a046be33 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -1535,7 +1535,7 @@Method Details
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. @@ -2117,7 +2117,7 @@Method Details
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html index f7204857b13..cede0040722 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html @@ -287,7 +287,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html new file mode 100644 index 00000000000..b60d49b9b33 --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html @@ -0,0 +1,226 @@ + + + +Discovery Engine API . projects . locations . collections . engines . assistants
+Instance Methods
++
+close()Close httplib2 connections.
++
+streamAssist(name, body=None, x__xgafv=None)Assists the user with a query in a streaming fashion.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html index 761b71f8329..40e878d64bb 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html @@ -74,6 +74,11 @@streamAssist(name, body=None, x__xgafv=None)+Assists the user with a query in a streaming fashion. + +Args: + name: string, Required. The resource name of the Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` (required) + body: object, The request body. + The object takes the form of: + +{ # Request for the AssistantService.StreamAssist method. + "generationSpec": { # Assistant generation specification for the request. This allows to override the default generation configuration at the engine level. # Optional. Specification of the generation configuration for the request. + "modelId": "A String", # Optional. The Vertex AI model_id used for the generative model. If not set, the default Assistant model will be used. + }, + "query": { # Defines a user inputed query. # Optional. Current user query. Empty query is only supported if `file_ids` are provided. In this case, the answer will be generated based on those context files. + "queryId": "A String", # Output only. Unique Id for the query. + "text": "A String", # Plain text. + }, + "session": "A String", # Optional. The session to use for the request. If specified, the assistant has access to the session history, and the query and the answer are stored there. If `-` is specified as the session ID, or it is left empty, then a new session is created with an automatically generated ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` + "toolsSpec": { # Specification of tools that are used to serve the request. # Optional. Specification of tools that are used to serve the request. + "imageGenerationSpec": { # Specification of the image generation tool. # Optional. Specification of the image generation tool. + }, + "toolRegistry": "A String", # Optional. The name of the tool registry to use. Format: `projects/{project}/locations/{location}/toolRegistries/{tool_registry}` + "vertexAiSearchSpec": { # Specification of the Vertex AI Search tool. # Optional. Specification of the Vertex AI Search tool. + "dataStoreSpecs": [ # Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. + { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. + "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) + "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. + { # Boost applies to documents which match a condition. + "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable). + "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below. + }, + "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` + }, + ], + }, + "customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). + "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "disabled": True or False, # Optional. Deprecated. Please refrain from using this field. Whether the Vertex AI Search tool is disabled. Default value is false, the tool is enabled by default. + "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + "videoGenerationSpec": { # Specification of the video generation tool. # Optional. Specification of the video generation tool. + }, + "webGroundingSpec": { # Specification of the web grounding tool. # Optional. Specification of the web grounding tool. If field is present, enables grounding with web search. Works only if Assistant.web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. + "enabled": True or False, # Optional. Deprecated. Please refrain from using this field. Whether the web grounding tool is enabled. + }, + }, + "userMetadata": { # User metadata of the request. # Optional. Information about the user initiating the query. + "preferredLanguageCode": "A String", # Optional. Preferred language to be used for answering if language detection fails. Also used as the language of error messages created by actions, regardless of language detection results. + "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. + }, +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response for the AssistantService.StreamAssist method. + "answer": { # AssistAnswer resource, main part of AssistResponse. # Assist answer resource object containing parts of the assistant's final answer for the user's query. Not present if the current response doesn't add anything to previously sent AssistAnswer.replies. Observe AssistAnswer.state to see if more parts are to be expected. While the state is `IN_PROGRESS`, the AssistAnswer.replies field in each response will contain replies (reply fragments) to be appended to the ones received in previous responses. AssistAnswer.name won't be filled. If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response is the last response and AssistAnswer.name will have a value. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, + "assistToken": "A String", # A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support. + "sessionInfo": { # Information about the session. # Session information. + "session": "A String", # Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`. + }, +}+Discovery Engine API . projects . locations . collections . engines
Instance Methods
++
+assistants()+Returns the assistants Resource.
+ @@ -177,7 +182,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -320,7 +325,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -404,7 +409,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -495,7 +500,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -568,7 +573,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -653,7 +658,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -738,7 +743,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html index c5cbc702a9b..cce41015d47 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -1535,7 +1535,7 @@Method Details
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. @@ -2117,7 +2117,7 @@Method Details
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html index b9b3caee7ac..b61b849b429 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html @@ -287,7 +287,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html index 41aee39f4b2..bdbbbab453f 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.branches.documents.html @@ -432,7 +432,7 @@Method Details
"A String", ], }, - "idField": "A String", # The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. + "idField": "A String", # The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * BigtableSource. "inlineSource": { # The inline source for the input config for ImportDocuments method. # The Inline source for the input content for documents. "documents": [ # Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. { # Document captures all raw metadata information of items to be recommended or searched. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html index 16f29622d98..d52cff804f2 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html @@ -266,6 +266,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -294,6 +295,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -509,6 +511,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -537,6 +540,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -652,6 +656,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -680,6 +685,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -787,6 +793,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -815,6 +822,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -974,6 +982,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -1002,6 +1011,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -1143,6 +1153,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -1171,6 +1182,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -1281,6 +1293,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -1309,6 +1322,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -1354,6 +1368,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -1382,6 +1397,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index 868db05d4f4..3bd762ef720 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -1535,7 +1535,7 @@Method Details
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. @@ -2117,7 +2117,7 @@Method Details
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html index b81ad33419c..6610714de47 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html @@ -287,7 +287,7 @@Method Details
"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html index 7ca7b838dd2..d63140661a6 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html @@ -314,7 +314,7 @@Method Details
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. @@ -612,7 +612,7 @@Method Details
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. @@ -886,7 +886,7 @@Method Details
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html index 67a747fefb5..655f8c613e4 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.branches.documents.html @@ -392,7 +392,7 @@Method Details
"A String", ], }, - "idField": "A String", # The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. + "idField": "A String", # The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * BigtableSource. "inlineSource": { # The inline source for the input config for ImportDocuments method. # The Inline source for the input content for documents. "documents": [ # Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. { # Document captures all raw metadata information of items to be recommended or searched. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html index 3f198895462..462aed319af 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html @@ -263,6 +263,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -291,6 +292,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -480,6 +482,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -508,6 +511,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -653,6 +657,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -681,6 +686,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -814,6 +820,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -842,6 +849,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -957,6 +965,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -985,6 +994,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. 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 d357b8daa85..4ab11773832 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -1497,7 +1497,7 @@Method Details
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. @@ -2075,7 +2075,7 @@Method Details
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html new file mode 100644 index 00000000000..cfe9c7c2bd8 --- /dev/null +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html @@ -0,0 +1,226 @@ + + + +Discovery Engine API . projects . locations . collections . engines . assistants
+Instance Methods
++
+close()Close httplib2 connections.
++
+streamAssist(name, body=None, x__xgafv=None)Assists the user with a query in a streaming fashion.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html index 6e44e952f9c..c76b14675a9 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html @@ -74,6 +74,11 @@streamAssist(name, body=None, x__xgafv=None)+Assists the user with a query in a streaming fashion. + +Args: + name: string, Required. The resource name of the Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` (required) + body: object, The request body. + The object takes the form of: + +{ # Request for the AssistantService.StreamAssist method. + "generationSpec": { # Assistant generation specification for the request. This allows to override the default generation configuration at the engine level. # Optional. Specification of the generation configuration for the request. + "modelId": "A String", # Optional. The Vertex AI model_id used for the generative model. If not set, the default Assistant model will be used. + }, + "query": { # Defines a user inputed query. # Optional. Current user query. Empty query is only supported if `file_ids` are provided. In this case, the answer will be generated based on those context files. + "queryId": "A String", # Output only. Unique Id for the query. + "text": "A String", # Plain text. + }, + "session": "A String", # Optional. The session to use for the request. If specified, the assistant has access to the session history, and the query and the answer are stored there. If `-` is specified as the session ID, or it is left empty, then a new session is created with an automatically generated ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` + "toolsSpec": { # Specification of tools that are used to serve the request. # Optional. Specification of tools that are used to serve the request. + "imageGenerationSpec": { # Specification of the image generation tool. # Optional. Specification of the image generation tool. + }, + "toolRegistry": "A String", # Optional. The name of the tool registry to use. Format: `projects/{project}/locations/{location}/toolRegistries/{tool_registry}` + "vertexAiSearchSpec": { # Specification of the Vertex AI Search tool. # Optional. Specification of the Vertex AI Search tool. + "dataStoreSpecs": [ # Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. + { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. + "boostSpec": { # Boost specification to boost certain documents. # Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) + "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. + { # Boost applies to documents which match a condition. + "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied. + "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value. + "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable). + "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + }, + ], + "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount. + "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below. + }, + "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` + }, + ], + }, + "customSearchOperators": "A String", # Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). + "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "disabled": True or False, # Optional. Deprecated. Please refrain from using this field. Whether the Vertex AI Search tool is disabled. Default value is false, the tool is enabled by default. + "filter": "A String", # Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + "videoGenerationSpec": { # Specification of the video generation tool. # Optional. Specification of the video generation tool. + }, + "webGroundingSpec": { # Specification of the web grounding tool. # Optional. Specification of the web grounding tool. If field is present, enables grounding with web search. Works only if Assistant.web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. + "enabled": True or False, # Optional. Deprecated. Please refrain from using this field. Whether the web grounding tool is enabled. + }, + }, + "userMetadata": { # User metadata of the request. # Optional. Information about the user initiating the query. + "preferredLanguageCode": "A String", # Optional. Preferred language to be used for answering if language detection fails. Also used as the language of error messages created by actions, regardless of language detection results. + "timeZone": "A String", # Optional. IANA time zone, e.g. Europe/Budapest. + }, +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response for the AssistantService.StreamAssist method. + "answer": { # AssistAnswer resource, main part of AssistResponse. # Assist answer resource object containing parts of the assistant's final answer for the user's query. Not present if the current response doesn't add anything to previously sent AssistAnswer.replies. Observe AssistAnswer.state to see if more parts are to be expected. While the state is `IN_PROGRESS`, the AssistAnswer.replies field in each response will contain replies (reply fragments) to be appended to the ones received in previous responses. AssistAnswer.name won't be filled. If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response is the last response and AssistAnswer.name will have a value. + "assistSkippedReasons": [ # Reasons for not answering the assist call. + "A String", + ], + "replies": [ # Replies of the assistant. + { # One part of the multi-part response of the assist call. + "groundedContent": { # A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like "Of course, I will gladly search it for you." do not need grounding. # Possibly grounded response text or media from the assistant. + "content": { # Multi-modal content. # The content. + "codeExecutionResult": { # Result of executing ExecutableCode. # Result of executing an ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed by the model. # Code generated by the model that is meant to be executed. + "code": "A String", # Required. The code content. Currently only supports Python. + }, + "file": { # A file, e.g., an audio summary. # A file, e.g., an audio summary. + "fileId": "A String", # Required. The file ID. + "mimeType": "A String", # Required. The media type (MIME type) of the file. + }, + "inlineData": { # Inline blob. # Inline binary data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The media type (MIME type) of the generated data. + }, + "role": "A String", # The producer of the content. Can be "model" or "user". + "text": "A String", # Inline text. + "thought": True or False, # Optional. Indicates if the part is thought from the model. + }, + "textGroundingMetadata": { # Grounding details for text sources. # Metadata for grounding based on text sources. + "references": [ # References for the grounded text. + { # Referenced content and related document metadata. + "content": "A String", # Referenced text content. + "documentMetadata": { # Document metadata. # Document metadata. + "document": "A String", # Document resource name. + "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. + "pageIdentifier": "A String", # Page identifier. + "title": "A String", # Title. + "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website. + }, + }, + ], + "segments": [ # Grounding information for parts of the text. + { # Grounding information for a segment of the text. + "endIndex": "A String", # End of the segment, exclusive. + "groundingScore": 3.14, # Score for the segment. + "referenceIndices": [ # References for the segment. + 42, + ], + "startIndex": "A String", # Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). + "text": "A String", # The text segment itself. + }, + ], + }, + }, + }, + ], + "state": "A String", # State of the answer generation. + }, + "assistToken": "A String", # A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support. + "sessionInfo": { # Information about the session. # Session information. + "session": "A String", # Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`. + }, +}+Discovery Engine API . projects . locations . collections . engines
Instance Methods
++
+assistants()+Returns the assistants Resource.
+ @@ -172,7 +177,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -306,7 +311,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -381,7 +386,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -463,7 +468,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -527,7 +532,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -603,7 +608,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -679,7 +684,7 @@Method Details
], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html index 5f834083026..6ecc8a40f0e 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -1497,7 +1497,7 @@Method Details
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. @@ -2075,7 +2075,7 @@Method Details
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html index 04deb15b201..bbba5a7a008 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.branches.documents.html @@ -392,7 +392,7 @@Method Details
"A String", ], }, - "idField": "A String", # The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. + "idField": "A String", # The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * BigtableSource. "inlineSource": { # The inline source for the input config for ImportDocuments method. # The Inline source for the input content for documents. "documents": [ # Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. { # Document captures all raw metadata information of items to be recommended or searched. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html index 3e061cf2d7e..ec560cc504c 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html @@ -255,6 +255,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -283,6 +284,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -472,6 +474,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -500,6 +503,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -645,6 +649,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -673,6 +678,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -806,6 +812,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -834,6 +841,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -949,6 +957,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. @@ -977,6 +986,7 @@Method Details
"digitalParsingConfig": { # The digital parsing configurations for documents. # Configurations applied to digital parser. }, "layoutParsingConfig": { # The layout parsing configurations for documents. # Configurations applied to layout parser. + "enableGetProcessedDocument": True or False, # Optional. If true, the processed document will be made available for the GetProcessedDocument API. "enableImageAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the image during parsing. "enableTableAnnotation": True or False, # Optional. If true, the LLM based annotation is added to the table during parsing. "excludeHtmlClasses": [ # Optional. List of HTML classes to exclude from the parsed content. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index 281dad7e918..2e477c35f3b 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -1497,7 +1497,7 @@Method Details
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. @@ -2075,7 +2075,7 @@Method Details
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html index a0675cf1cc5..484f9010797 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html @@ -311,7 +311,7 @@Method Details
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. @@ -605,7 +605,7 @@Method Details
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. @@ -875,7 +875,7 @@Method Details
"condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED. }, "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. diff --git a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html index 7ae1111251e..829e0a2ec17 100644 --- a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html @@ -206,6 +206,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, @@ -549,6 +555,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, @@ -916,6 +928,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, @@ -1270,6 +1288,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, @@ -1632,6 +1656,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, @@ -1976,6 +2006,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, diff --git a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html index 707bc022f1e..27575e61c4a 100644 --- a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html @@ -294,6 +294,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, @@ -1053,6 +1059,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, diff --git a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html index 5705c48d4cf..7110f0567e9 100644 --- a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html @@ -294,6 +294,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, @@ -997,6 +1003,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, diff --git a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html index 952a664bbc9..fdbf1915cdb 100644 --- a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html @@ -206,6 +206,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, @@ -549,6 +555,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, @@ -916,6 +928,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, @@ -1270,6 +1288,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, @@ -1632,6 +1656,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, @@ -1976,6 +2006,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, diff --git a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html index a1fadf510cc..bd3dab28e1d 100644 --- a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html @@ -294,6 +294,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, @@ -1053,6 +1059,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, diff --git a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html index fd779196199..ce8392b9a68 100644 --- a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html @@ -294,6 +294,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, @@ -997,6 +1003,12 @@Method Details
}, }, "processingLocation": { # Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided. # Optional. Processing location configuration. Vertex AI dataset scanning will set processing_location.image_fallback_type to MultiRegionProcessing by default. + "documentFallbackLocation": { # Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location. # Document processing will fall back using this configuration. + "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. + }, + "multiRegionProcessing": { # Processing will happen in a multi-region that contains the current region if available. # Processing will happen in a multi-region that contains the current region if available. + }, + }, "imageFallbackLocation": { # Configure image processing to fall back to the configured processing option below if unavailable in the request location. # Image processing will fall back using this configuration. "globalProcessing": { # Processing will happen in the global region. # Processing will happen in the global region. }, diff --git a/docs/dyn/documentai_v1.projects.locations.processors.html b/docs/dyn/documentai_v1.projects.locations.processors.html index be2376b0634..ef5f7020bd9 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.html @@ -271,7 +271,7 @@Method Details
The object takes the form of: { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. - "createTime": "A String", # The time the processor was created. + "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. "kmsKeyName": "A String", # The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. @@ -298,7 +298,7 @@Method Details
An object of the form: { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. - "createTime": "A String", # The time the processor was created. + "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. "kmsKeyName": "A String", # The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. @@ -449,7 +449,7 @@Method Details
An object of the form: { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. - "createTime": "A String", # The time the processor was created. + "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. "kmsKeyName": "A String", # The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. @@ -488,7 +488,7 @@Method Details
"nextPageToken": "A String", # Points to the next processor, otherwise empty. "processors": [ # The list of processors. { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. - "createTime": "A String", # The time the processor was created. + "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. "kmsKeyName": "A String", # The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. diff --git a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html index 159510a0f88..7561ec80361 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html @@ -401,13 +401,13 @@Method Details
An object of the form: { # A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version. - "createTime": "A String", # The time the processor version was created. - "deprecationInfo": { # Information about the upcoming deprecation of this processor version. # If set, information about the eventual deprecation of this version. + "createTime": "A String", # Output only. The time the processor version was created. + "deprecationInfo": { # Information about the upcoming deprecation of this processor version. # Output only. If set, information about the eventual deprecation of this version. "deprecationTime": "A String", # The time at which this processor version will be deprecated. "replacementProcessorVersion": "A String", # If set, the processor version that will be used as a replacement. }, "displayName": "A String", # The display name of the processor version. - "documentSchema": { # The schema defines the output of the processed document by a processor. # The schema of the processor version. Describes the output. + "documentSchema": { # The schema defines the output of the processed document by a processor. # Output only. The schema of the processor version. Describes the output. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show to users. "entityTypes": [ # Entity types of the schema. @@ -451,9 +451,9 @@Method Details
}, }, "googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google. - "kmsKeyName": "A String", # The KMS key name used for encryption. - "kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted. - "latestEvaluation": { # Gives a short summary of an evaluation, and links to the evaluation itself. # The most recently invoked evaluation for the processor version. + "kmsKeyName": "A String", # Output only. The KMS key name used for encryption. + "kmsKeyVersionName": "A String", # Output only. The KMS key version with which data is encrypted. + "latestEvaluation": { # Gives a short summary of an evaluation, and links to the evaluation itself. # Output only. The most recently invoked evaluation for the processor version. "aggregateMetrics": { # Evaluation metrics, either in aggregate or about a specific entity. # An aggregate of the statistics for the evaluation with fuzzy matching on. "f1Score": 3.14, # The calculated f1 score. "falseNegativesCount": 42, # The amount of false negatives. @@ -511,13 +511,13 @@Method Details
"nextPageToken": "A String", # Points to the next processor, otherwise empty. "processorVersions": [ # The list of processors. { # A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version. - "createTime": "A String", # The time the processor version was created. - "deprecationInfo": { # Information about the upcoming deprecation of this processor version. # If set, information about the eventual deprecation of this version. + "createTime": "A String", # Output only. The time the processor version was created. + "deprecationInfo": { # Information about the upcoming deprecation of this processor version. # Output only. If set, information about the eventual deprecation of this version. "deprecationTime": "A String", # The time at which this processor version will be deprecated. "replacementProcessorVersion": "A String", # If set, the processor version that will be used as a replacement. }, "displayName": "A String", # The display name of the processor version. - "documentSchema": { # The schema defines the output of the processed document by a processor. # The schema of the processor version. Describes the output. + "documentSchema": { # The schema defines the output of the processed document by a processor. # Output only. The schema of the processor version. Describes the output. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show to users. "entityTypes": [ # Entity types of the schema. @@ -561,9 +561,9 @@Method Details
}, }, "googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google. - "kmsKeyName": "A String", # The KMS key name used for encryption. - "kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted. - "latestEvaluation": { # Gives a short summary of an evaluation, and links to the evaluation itself. # The most recently invoked evaluation for the processor version. + "kmsKeyName": "A String", # Output only. The KMS key name used for encryption. + "kmsKeyVersionName": "A String", # Output only. The KMS key version with which data is encrypted. + "latestEvaluation": { # Gives a short summary of an evaluation, and links to the evaluation itself. # Output only. The most recently invoked evaluation for the processor version. "aggregateMetrics": { # Evaluation metrics, either in aggregate or about a specific entity. # An aggregate of the statistics for the evaluation with fuzzy matching on. "f1Score": 3.14, # The calculated f1 score. "falseNegativesCount": 42, # The amount of false negatives. @@ -2715,13 +2715,13 @@Method Details
}, }, "processorVersion": { # A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version. # Required. The processor version to be created. - "createTime": "A String", # The time the processor version was created. - "deprecationInfo": { # Information about the upcoming deprecation of this processor version. # If set, information about the eventual deprecation of this version. + "createTime": "A String", # Output only. The time the processor version was created. + "deprecationInfo": { # Information about the upcoming deprecation of this processor version. # Output only. If set, information about the eventual deprecation of this version. "deprecationTime": "A String", # The time at which this processor version will be deprecated. "replacementProcessorVersion": "A String", # If set, the processor version that will be used as a replacement. }, "displayName": "A String", # The display name of the processor version. - "documentSchema": { # The schema defines the output of the processed document by a processor. # The schema of the processor version. Describes the output. + "documentSchema": { # The schema defines the output of the processed document by a processor. # Output only. The schema of the processor version. Describes the output. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show to users. "entityTypes": [ # Entity types of the schema. @@ -2765,9 +2765,9 @@Method Details
}, }, "googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google. - "kmsKeyName": "A String", # The KMS key name used for encryption. - "kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted. - "latestEvaluation": { # Gives a short summary of an evaluation, and links to the evaluation itself. # The most recently invoked evaluation for the processor version. + "kmsKeyName": "A String", # Output only. The KMS key name used for encryption. + "kmsKeyVersionName": "A String", # Output only. The KMS key version with which data is encrypted. + "latestEvaluation": { # Gives a short summary of an evaluation, and links to the evaluation itself. # Output only. The most recently invoked evaluation for the processor version. "aggregateMetrics": { # Evaluation metrics, either in aggregate or about a specific entity. # An aggregate of the statistics for the evaluation with fuzzy matching on. "f1Score": 3.14, # The calculated f1 score. "falseNegativesCount": 42, # The amount of false negatives. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.html index 762eda4b77e..bf4bb3c3df1 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.html @@ -308,7 +308,7 @@Method Details
The object takes the form of: { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. - "createTime": "A String", # The time the processor was created. + "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. "kmsKeyName": "A String", # The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. @@ -335,7 +335,7 @@Method Details
An object of the form: { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. - "createTime": "A String", # The time the processor was created. + "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. "kmsKeyName": "A String", # The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. @@ -486,7 +486,7 @@Method Details
An object of the form: { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. - "createTime": "A String", # The time the processor was created. + "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. "kmsKeyName": "A String", # The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. @@ -525,7 +525,7 @@Method Details
"nextPageToken": "A String", # Points to the next processor, otherwise empty. "processors": [ # The list of processors. { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. - "createTime": "A String", # The time the processor was created. + "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. "kmsKeyName": "A String", # The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html index aa3aeb7594f..a5aa69757c0 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html @@ -433,13 +433,13 @@Method Details
An object of the form: { # A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version. - "createTime": "A String", # The time the processor version was created. - "deprecationInfo": { # Information about the upcoming deprecation of this processor version. # If set, information about the eventual deprecation of this version. + "createTime": "A String", # Output only. The time the processor version was created. + "deprecationInfo": { # Information about the upcoming deprecation of this processor version. # Output only. If set, information about the eventual deprecation of this version. "deprecationTime": "A String", # The time at which this processor version will be deprecated. "replacementProcessorVersion": "A String", # If set, the processor version that will be used as a replacement. }, "displayName": "A String", # The display name of the processor version. - "documentSchema": { # The schema defines the output of the processed document by a processor. # The schema of the processor version. Describes the output. + "documentSchema": { # The schema defines the output of the processed document by a processor. # Output only. The schema of the processor version. Describes the output. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show to users. "entityTypes": [ # Entity types of the schema. @@ -497,9 +497,9 @@Method Details
}, }, "googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google. - "kmsKeyName": "A String", # The KMS key name used for encryption. - "kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted. - "latestEvaluation": { # Gives a short summary of an evaluation, and links to the evaluation itself. # The most recently invoked evaluation for the processor version. + "kmsKeyName": "A String", # Output only. The KMS key name used for encryption. + "kmsKeyVersionName": "A String", # Output only. The KMS key version with which data is encrypted. + "latestEvaluation": { # Gives a short summary of an evaluation, and links to the evaluation itself. # Output only. The most recently invoked evaluation for the processor version. "aggregateMetrics": { # Evaluation metrics, either in aggregate or about a specific entity. # An aggregate of the statistics for the evaluation with fuzzy matching on. "f1Score": 3.14, # The calculated f1 score. "falseNegativesCount": 42, # The amount of false negatives. @@ -603,13 +603,13 @@Method Details
"nextPageToken": "A String", # Points to the next processor, otherwise empty. "processorVersions": [ # The list of processors. { # A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version. - "createTime": "A String", # The time the processor version was created. - "deprecationInfo": { # Information about the upcoming deprecation of this processor version. # If set, information about the eventual deprecation of this version. + "createTime": "A String", # Output only. The time the processor version was created. + "deprecationInfo": { # Information about the upcoming deprecation of this processor version. # Output only. If set, information about the eventual deprecation of this version. "deprecationTime": "A String", # The time at which this processor version will be deprecated. "replacementProcessorVersion": "A String", # If set, the processor version that will be used as a replacement. }, "displayName": "A String", # The display name of the processor version. - "documentSchema": { # The schema defines the output of the processed document by a processor. # The schema of the processor version. Describes the output. + "documentSchema": { # The schema defines the output of the processed document by a processor. # Output only. The schema of the processor version. Describes the output. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show to users. "entityTypes": [ # Entity types of the schema. @@ -667,9 +667,9 @@Method Details
}, }, "googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google. - "kmsKeyName": "A String", # The KMS key name used for encryption. - "kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted. - "latestEvaluation": { # Gives a short summary of an evaluation, and links to the evaluation itself. # The most recently invoked evaluation for the processor version. + "kmsKeyName": "A String", # Output only. The KMS key name used for encryption. + "kmsKeyVersionName": "A String", # Output only. The KMS key version with which data is encrypted. + "latestEvaluation": { # Gives a short summary of an evaluation, and links to the evaluation itself. # Output only. The most recently invoked evaluation for the processor version. "aggregateMetrics": { # Evaluation metrics, either in aggregate or about a specific entity. # An aggregate of the statistics for the evaluation with fuzzy matching on. "f1Score": 3.14, # The calculated f1 score. "falseNegativesCount": 42, # The amount of false negatives. @@ -3919,13 +3919,13 @@Method Details
}, }, "processorVersion": { # A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version. # Required. The processor version to be created. - "createTime": "A String", # The time the processor version was created. - "deprecationInfo": { # Information about the upcoming deprecation of this processor version. # If set, information about the eventual deprecation of this version. + "createTime": "A String", # Output only. The time the processor version was created. + "deprecationInfo": { # Information about the upcoming deprecation of this processor version. # Output only. If set, information about the eventual deprecation of this version. "deprecationTime": "A String", # The time at which this processor version will be deprecated. "replacementProcessorVersion": "A String", # If set, the processor version that will be used as a replacement. }, "displayName": "A String", # The display name of the processor version. - "documentSchema": { # The schema defines the output of the processed document by a processor. # The schema of the processor version. Describes the output. + "documentSchema": { # The schema defines the output of the processed document by a processor. # Output only. The schema of the processor version. Describes the output. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show to users. "entityTypes": [ # Entity types of the schema. @@ -3983,9 +3983,9 @@Method Details
}, }, "googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google. - "kmsKeyName": "A String", # The KMS key name used for encryption. - "kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted. - "latestEvaluation": { # Gives a short summary of an evaluation, and links to the evaluation itself. # The most recently invoked evaluation for the processor version. + "kmsKeyName": "A String", # Output only. The KMS key name used for encryption. + "kmsKeyVersionName": "A String", # Output only. The KMS key version with which data is encrypted. + "latestEvaluation": { # Gives a short summary of an evaluation, and links to the evaluation itself. # Output only. The most recently invoked evaluation for the processor version. "aggregateMetrics": { # Evaluation metrics, either in aggregate or about a specific entity. # An aggregate of the statistics for the evaluation with fuzzy matching on. "f1Score": 3.14, # The calculated f1 score. "falseNegativesCount": 42, # The amount of false negatives. diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index 337fe9aa732..2341d6a351e 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -294,7 +294,7 @@Method Details
}, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, - "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. @@ -380,6 +380,37 @@Method Details
"responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. }, ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. Only API key is supported. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. @@ -728,7 +759,7 @@Method Details
}, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, - "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. @@ -814,6 +845,37 @@Method Details
"responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. }, ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. Only API key is supported. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. @@ -995,8 +1057,15 @@Method Details
"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. + "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. + "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. + "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. + "text": "A String", # Text of the chunk. + "title": "A String", # Title of the chunk. + "uri": "A String", # URI reference of the chunk. + }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document. @@ -1366,7 +1435,7 @@Method Details
}, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. }, - "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. @@ -1452,6 +1521,37 @@Method Details
"responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. }, ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. Only API key is supported. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. }, "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. @@ -1633,8 +1733,15 @@Method Details
"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. + "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. + "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. + "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. + "text": "A String", # Text of the chunk. + "title": "A String", # Title of the chunk. + "uri": "A String", # URI reference of the chunk. + }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document. diff --git a/docs/dyn/gkehub_v1.projects.locations.memberships.html b/docs/dyn/gkehub_v1.projects.locations.memberships.html index bf486765d80..28671100b21 100644 --- a/docs/dyn/gkehub_v1.projects.locations.memberships.html +++ b/docs/dyn/gkehub_v1.projects.locations.memberships.html @@ -201,6 +201,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. @@ -400,6 +401,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. @@ -554,6 +556,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. @@ -667,6 +670,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. diff --git a/docs/dyn/gkehub_v1.projects.locations.scopes.html b/docs/dyn/gkehub_v1.projects.locations.scopes.html index cdd5e67efc1..e7bdea45fee 100644 --- a/docs/dyn/gkehub_v1.projects.locations.scopes.html +++ b/docs/dyn/gkehub_v1.projects.locations.scopes.html @@ -430,6 +430,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html b/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html index 8e1fe5bbf50..167aa44c157 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.memberships.html @@ -216,6 +216,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. @@ -437,6 +438,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. @@ -591,6 +593,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. @@ -701,6 +704,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. @@ -829,6 +833,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. @@ -1069,6 +1074,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.scopes.html b/docs/dyn/gkehub_v1alpha.projects.locations.scopes.html index cd8e0a52f2d..ec8b32b87eb 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.scopes.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.scopes.html @@ -430,6 +430,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. diff --git a/docs/dyn/gkehub_v1beta.projects.locations.memberships.html b/docs/dyn/gkehub_v1beta.projects.locations.memberships.html index e5d3f54c986..9dcb0172ed7 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.memberships.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.memberships.html @@ -201,6 +201,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. @@ -400,6 +401,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. @@ -554,6 +556,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. @@ -667,6 +670,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. diff --git a/docs/dyn/gkehub_v1beta.projects.locations.scopes.html b/docs/dyn/gkehub_v1beta.projects.locations.scopes.html index ba691e5b354..d4b13030d52 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.scopes.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.scopes.html @@ -430,6 +430,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. diff --git a/docs/dyn/gkehub_v1beta1.projects.locations.memberships.html b/docs/dyn/gkehub_v1beta1.projects.locations.memberships.html index 4b9b7d605a1..fa8f55cf88c 100644 --- a/docs/dyn/gkehub_v1beta1.projects.locations.memberships.html +++ b/docs/dyn/gkehub_v1beta1.projects.locations.memberships.html @@ -196,6 +196,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. @@ -419,6 +420,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. @@ -574,6 +576,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. @@ -688,6 +691,7 @@Method Details
"a_key": "A String", }, "lastConnectionTime": "A String", # Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. + "membershipType": "A String", # Output only. The type of the membership. "monitoringConfig": { # MonitoringConfig informs Fleet-based applications/services/UIs how the metrics for the underlying cluster is reported to cloud monitoring services. It can be set from empty to non-empty, but can't be mutated directly to prevent accidentally breaking the constinousty of metrics. # Optional. The monitoring config information for this membership. "cluster": "A String", # Optional. Cluster name used to report metrics. For Anthos on VMWare/Baremetal/MultiCloud clusters, it would be in format {cluster_type}/{cluster_name}, e.g., "awsClusters/cluster_1". "clusterHash": "A String", # Optional. For GKE and Multicloud clusters, this is the UUID of the cluster resource. For VMWare and Baremetal clusters, this is the kube-system UID. diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html index e4230341011..689efef38bf 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html @@ -165,6 +165,11 @@Method Details
"pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, + "notificationConfigs": [ # Optional. Specifies where and whether to send notifications upon changes to a DICOM store. + { # Contains the configuration for DICOM notifications. + "pubsubTopic": "A String", # Required. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. * `PubsubMessage.Attributes` contains the following attributes: * `action`: The name of the endpoint that generated the notification. Possible values are `StoreInstances`, `SetBlobSettings`, `ImportDicomData`, etc. * `lastUpdatedTime`: The latest timestamp when the DICOM instance was updated. * `storeName`: The resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * `studyInstanceUID`: The study UID of the DICOM instance that was changed. * `seriesInstanceUID`: The series UID of the DICOM instance that was changed. * `sopInstanceUID`: The instance UID of the DICOM instance that was changed. * `versionId`: The version ID of the DICOM instance that was changed. * `modality`: The modality tag of the DICOM instance that was changed. * `previousStorageClass`: The storage class where the DICOM instance was previously stored if the storage class was changed. * `storageClass`: The storage class where the DICOM instance is currently stored. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have the `pubsub.topics.publish` permission (which is typically included in `roles/pubsub.publisher` role) on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). + }, + ], "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes the output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). @@ -194,6 +199,11 @@Method Details
"pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, + "notificationConfigs": [ # Optional. Specifies where and whether to send notifications upon changes to a DICOM store. + { # Contains the configuration for DICOM notifications. + "pubsubTopic": "A String", # Required. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. * `PubsubMessage.Attributes` contains the following attributes: * `action`: The name of the endpoint that generated the notification. Possible values are `StoreInstances`, `SetBlobSettings`, `ImportDicomData`, etc. * `lastUpdatedTime`: The latest timestamp when the DICOM instance was updated. * `storeName`: The resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * `studyInstanceUID`: The study UID of the DICOM instance that was changed. * `seriesInstanceUID`: The series UID of the DICOM instance that was changed. * `sopInstanceUID`: The instance UID of the DICOM instance that was changed. * `versionId`: The version ID of the DICOM instance that was changed. * `modality`: The modality tag of the DICOM instance that was changed. * `previousStorageClass`: The storage class where the DICOM instance was previously stored if the storage class was changed. * `storageClass`: The storage class where the DICOM instance is currently stored. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have the `pubsub.topics.publish` permission (which is typically included in `roles/pubsub.publisher` role) on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). + }, + ], "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes the output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). @@ -435,6 +445,11 @@Method Details
"pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, + "notificationConfigs": [ # Optional. Specifies where and whether to send notifications upon changes to a DICOM store. + { # Contains the configuration for DICOM notifications. + "pubsubTopic": "A String", # Required. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. * `PubsubMessage.Attributes` contains the following attributes: * `action`: The name of the endpoint that generated the notification. Possible values are `StoreInstances`, `SetBlobSettings`, `ImportDicomData`, etc. * `lastUpdatedTime`: The latest timestamp when the DICOM instance was updated. * `storeName`: The resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * `studyInstanceUID`: The study UID of the DICOM instance that was changed. * `seriesInstanceUID`: The series UID of the DICOM instance that was changed. * `sopInstanceUID`: The instance UID of the DICOM instance that was changed. * `versionId`: The version ID of the DICOM instance that was changed. * `modality`: The modality tag of the DICOM instance that was changed. * `previousStorageClass`: The storage class where the DICOM instance was previously stored if the storage class was changed. * `storageClass`: The storage class where the DICOM instance is currently stored. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have the `pubsub.topics.publish` permission (which is typically included in `roles/pubsub.publisher` role) on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). + }, + ], "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes the output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). @@ -594,6 +609,11 @@Method Details
"pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, + "notificationConfigs": [ # Optional. Specifies where and whether to send notifications upon changes to a DICOM store. + { # Contains the configuration for DICOM notifications. + "pubsubTopic": "A String", # Required. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. * `PubsubMessage.Attributes` contains the following attributes: * `action`: The name of the endpoint that generated the notification. Possible values are `StoreInstances`, `SetBlobSettings`, `ImportDicomData`, etc. * `lastUpdatedTime`: The latest timestamp when the DICOM instance was updated. * `storeName`: The resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * `studyInstanceUID`: The study UID of the DICOM instance that was changed. * `seriesInstanceUID`: The series UID of the DICOM instance that was changed. * `sopInstanceUID`: The instance UID of the DICOM instance that was changed. * `versionId`: The version ID of the DICOM instance that was changed. * `modality`: The modality tag of the DICOM instance that was changed. * `previousStorageClass`: The storage class where the DICOM instance was previously stored if the storage class was changed. * `storageClass`: The storage class where the DICOM instance is currently stored. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have the `pubsub.topics.publish` permission (which is typically included in `roles/pubsub.publisher` role) on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). + }, + ], "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes the output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). @@ -641,6 +661,11 @@Method Details
"pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, + "notificationConfigs": [ # Optional. Specifies where and whether to send notifications upon changes to a DICOM store. + { # Contains the configuration for DICOM notifications. + "pubsubTopic": "A String", # Required. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. * `PubsubMessage.Attributes` contains the following attributes: * `action`: The name of the endpoint that generated the notification. Possible values are `StoreInstances`, `SetBlobSettings`, `ImportDicomData`, etc. * `lastUpdatedTime`: The latest timestamp when the DICOM instance was updated. * `storeName`: The resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * `studyInstanceUID`: The study UID of the DICOM instance that was changed. * `seriesInstanceUID`: The series UID of the DICOM instance that was changed. * `sopInstanceUID`: The instance UID of the DICOM instance that was changed. * `versionId`: The version ID of the DICOM instance that was changed. * `modality`: The modality tag of the DICOM instance that was changed. * `previousStorageClass`: The storage class where the DICOM instance was previously stored if the storage class was changed. * `storageClass`: The storage class where the DICOM instance is currently stored. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have the `pubsub.topics.publish` permission (which is typically included in `roles/pubsub.publisher` role) on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). + }, + ], "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes the output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). @@ -670,6 +695,11 @@Method Details
"pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, + "notificationConfigs": [ # Optional. Specifies where and whether to send notifications upon changes to a DICOM store. + { # Contains the configuration for DICOM notifications. + "pubsubTopic": "A String", # Required. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. * `PubsubMessage.Attributes` contains the following attributes: * `action`: The name of the endpoint that generated the notification. Possible values are `StoreInstances`, `SetBlobSettings`, `ImportDicomData`, etc. * `lastUpdatedTime`: The latest timestamp when the DICOM instance was updated. * `storeName`: The resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * `studyInstanceUID`: The study UID of the DICOM instance that was changed. * `seriesInstanceUID`: The series UID of the DICOM instance that was changed. * `sopInstanceUID`: The instance UID of the DICOM instance that was changed. * `versionId`: The version ID of the DICOM instance that was changed. * `modality`: The modality tag of the DICOM instance that was changed. * `previousStorageClass`: The storage class where the DICOM instance was previously stored if the storage class was changed. * `storageClass`: The storage class where the DICOM instance is currently stored. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have the `pubsub.topics.publish` permission (which is typically included in `roles/pubsub.publisher` role) on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). + }, + ], "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes the output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.bulkdata.html b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.bulkdata.html new file mode 100644 index 00000000000..9c26527f749 --- /dev/null +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.bulkdata.html @@ -0,0 +1,115 @@ + + + +Cloud Healthcare API . projects . locations . datasets . dicomStores . studies . series . instances . bulkdata
+Instance Methods
++
+close()Close httplib2 connections.
++
+retrieveBulkdata(parent, dicomWebPath, x__xgafv=None)Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4){: .external}. For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata).
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.html b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.html index 5da29d8e287..2728dadc88b 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.studies.series.instances.html @@ -74,6 +74,11 @@retrieveBulkdata(parent, dicomWebPath, x__xgafv=None)+Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4){: .external}. For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata). + +Args: + parent: string, Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. (required) + dicomWebPath: string, Required. The path for the `RetrieveBulkdata` DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/bukdata/{bulkdata_uri}`. (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. + }, + ], +}+Cloud Healthcare API . projects . locations . datasets . dicomStores . studies . series . instances
Instance Methods
++
+bulkdata()+Returns the bulkdata Resource.
+ diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html index a0dbd60b93a..a3c741e6c60 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html @@ -145,7 +145,7 @@Instance Methods
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).
-
update(name, body=None, x__xgafv=None)Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update), [R5](https://hl7.org/fhir/R5/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. In R5, the conditional update interaction If-None-Match is supported, including the wildcard behaviour. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).
+Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update), [R5](https://hl7.org/fhir/R5/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The conditional update interaction If-None-Match is supported, including the wildcard behaviour, as defined by the R5 spec. This functionality is supported in R4 and R5. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).
Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#vread), [STU3](https://hl7.org/fhir/STU3/http.html#vread), [R4](https://hl7.org/fhir/R4/http.html#vread), [R5](https://hl7.org/fhir/R5/http.html#vread)). On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version).
@@ -833,7 +833,7 @@Method Details
update(name, body=None, x__xgafv=None)-Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update), [R5](https://hl7.org/fhir/R5/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. In R5, the conditional update interaction If-None-Match is supported, including the wildcard behaviour. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource). +Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update), [R5](https://hl7.org/fhir/R5/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The conditional update interaction If-None-Match is supported, including the wildcard behaviour, as defined by the R5 spec. This functionality is supported in R4 and R5. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource). Args: name: string, Required. The name of the resource to update. (required) diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html index 201895f7b12..25adb3d80b1 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html @@ -165,6 +165,11 @@Method Details
"pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, + "notificationConfigs": [ # Optional. Specifies where and whether to send notifications upon changes to a DICOM store. + { # Contains the configuration for DICOM notifications. + "pubsubTopic": "A String", # Required. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. * `PubsubMessage.Attributes` contains the following attributes: * `action`: The name of the endpoint that generated the notification. Possible values are `StoreInstances`, `SetBlobSettings`, `ImportDicomData`, etc. * `lastUpdatedTime`: The latest timestamp when the DICOM instance was updated. * `storeName`: The resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * `studyInstanceUID`: The study UID of the DICOM instance that was changed. * `seriesInstanceUID`: The series UID of the DICOM instance that was changed. * `sopInstanceUID`: The instance UID of the DICOM instance that was changed. * `versionId`: The version ID of the DICOM instance that was changed. * `modality`: The modality tag of the DICOM instance that was changed. * `previousStorageClass`: The storage class where the DICOM instance was previously stored if the storage class was changed. * `storageClass`: The storage class where the DICOM instance is currently stored. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have the `pubsub.topics.publish` permission (which is typically included in `roles/pubsub.publisher` role) on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). + }, + ], "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). @@ -194,6 +199,11 @@Method Details
"pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, + "notificationConfigs": [ # Optional. Specifies where and whether to send notifications upon changes to a DICOM store. + { # Contains the configuration for DICOM notifications. + "pubsubTopic": "A String", # Required. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. * `PubsubMessage.Attributes` contains the following attributes: * `action`: The name of the endpoint that generated the notification. Possible values are `StoreInstances`, `SetBlobSettings`, `ImportDicomData`, etc. * `lastUpdatedTime`: The latest timestamp when the DICOM instance was updated. * `storeName`: The resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * `studyInstanceUID`: The study UID of the DICOM instance that was changed. * `seriesInstanceUID`: The series UID of the DICOM instance that was changed. * `sopInstanceUID`: The instance UID of the DICOM instance that was changed. * `versionId`: The version ID of the DICOM instance that was changed. * `modality`: The modality tag of the DICOM instance that was changed. * `previousStorageClass`: The storage class where the DICOM instance was previously stored if the storage class was changed. * `storageClass`: The storage class where the DICOM instance is currently stored. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have the `pubsub.topics.publish` permission (which is typically included in `roles/pubsub.publisher` role) on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). + }, + ], "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). @@ -542,6 +552,11 @@Method Details
"pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, + "notificationConfigs": [ # Optional. Specifies where and whether to send notifications upon changes to a DICOM store. + { # Contains the configuration for DICOM notifications. + "pubsubTopic": "A String", # Required. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. * `PubsubMessage.Attributes` contains the following attributes: * `action`: The name of the endpoint that generated the notification. Possible values are `StoreInstances`, `SetBlobSettings`, `ImportDicomData`, etc. * `lastUpdatedTime`: The latest timestamp when the DICOM instance was updated. * `storeName`: The resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * `studyInstanceUID`: The study UID of the DICOM instance that was changed. * `seriesInstanceUID`: The series UID of the DICOM instance that was changed. * `sopInstanceUID`: The instance UID of the DICOM instance that was changed. * `versionId`: The version ID of the DICOM instance that was changed. * `modality`: The modality tag of the DICOM instance that was changed. * `previousStorageClass`: The storage class where the DICOM instance was previously stored if the storage class was changed. * `storageClass`: The storage class where the DICOM instance is currently stored. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have the `pubsub.topics.publish` permission (which is typically included in `roles/pubsub.publisher` role) on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). + }, + ], "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). @@ -701,6 +716,11 @@Method Details
"pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, + "notificationConfigs": [ # Optional. Specifies where and whether to send notifications upon changes to a DICOM store. + { # Contains the configuration for DICOM notifications. + "pubsubTopic": "A String", # Required. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. * `PubsubMessage.Attributes` contains the following attributes: * `action`: The name of the endpoint that generated the notification. Possible values are `StoreInstances`, `SetBlobSettings`, `ImportDicomData`, etc. * `lastUpdatedTime`: The latest timestamp when the DICOM instance was updated. * `storeName`: The resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * `studyInstanceUID`: The study UID of the DICOM instance that was changed. * `seriesInstanceUID`: The series UID of the DICOM instance that was changed. * `sopInstanceUID`: The instance UID of the DICOM instance that was changed. * `versionId`: The version ID of the DICOM instance that was changed. * `modality`: The modality tag of the DICOM instance that was changed. * `previousStorageClass`: The storage class where the DICOM instance was previously stored if the storage class was changed. * `storageClass`: The storage class where the DICOM instance is currently stored. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have the `pubsub.topics.publish` permission (which is typically included in `roles/pubsub.publisher` role) on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). + }, + ], "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). @@ -748,6 +768,11 @@Method Details
"pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, + "notificationConfigs": [ # Optional. Specifies where and whether to send notifications upon changes to a DICOM store. + { # Contains the configuration for DICOM notifications. + "pubsubTopic": "A String", # Required. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. * `PubsubMessage.Attributes` contains the following attributes: * `action`: The name of the endpoint that generated the notification. Possible values are `StoreInstances`, `SetBlobSettings`, `ImportDicomData`, etc. * `lastUpdatedTime`: The latest timestamp when the DICOM instance was updated. * `storeName`: The resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * `studyInstanceUID`: The study UID of the DICOM instance that was changed. * `seriesInstanceUID`: The series UID of the DICOM instance that was changed. * `sopInstanceUID`: The instance UID of the DICOM instance that was changed. * `versionId`: The version ID of the DICOM instance that was changed. * `modality`: The modality tag of the DICOM instance that was changed. * `previousStorageClass`: The storage class where the DICOM instance was previously stored if the storage class was changed. * `storageClass`: The storage class where the DICOM instance is currently stored. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have the `pubsub.topics.publish` permission (which is typically included in `roles/pubsub.publisher` role) on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). + }, + ], "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). @@ -777,6 +802,11 @@Method Details
"pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. PubsubMessage.Data contains the resource name. PubsubMessage.MessageId is the ID of this message. It is guaranteed to be unique within the topic. PubsubMessage.PublishTime is the time at which the message was published. Notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. Cloud Healthcare API service account must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail. If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). If the number of errors exceeds a certain rate, some aren't submitted. Note that not all operations trigger notifications, see [Configuring Pub/Sub notifications](https://cloud.google.com/healthcare/docs/how-tos/pubsub) for specific details. "sendForBulkImport": True or False, # Indicates whether or not to send Pub/Sub notifications on bulk import. Only supported for DICOM imports. }, + "notificationConfigs": [ # Optional. Specifies where and whether to send notifications upon changes to a DICOM store. + { # Contains the configuration for DICOM notifications. + "pubsubTopic": "A String", # Required. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. * `PubsubMessage.Attributes` contains the following attributes: * `action`: The name of the endpoint that generated the notification. Possible values are `StoreInstances`, `SetBlobSettings`, `ImportDicomData`, etc. * `lastUpdatedTime`: The latest timestamp when the DICOM instance was updated. * `storeName`: The resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * `studyInstanceUID`: The study UID of the DICOM instance that was changed. * `seriesInstanceUID`: The series UID of the DICOM instance that was changed. * `sopInstanceUID`: The instance UID of the DICOM instance that was changed. * `versionId`: The version ID of the DICOM instance that was changed. * `modality`: The modality tag of the DICOM instance that was changed. * `previousStorageClass`: The storage class where the DICOM instance was previously stored if the storage class was changed. * `storageClass`: The storage class where the DICOM instance is currently stored. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have the `pubsub.topics.publish` permission (which is typically included in `roles/pubsub.publisher` role) on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). + }, + ], "streamConfigs": [ # Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. { # StreamConfig specifies configuration for a streaming DICOM export. "bigqueryDestination": { # The BigQuery table where the server writes output. # Results are appended to this table. The server creates a new table in the given BigQuery dataset if the specified table does not exist. To enable the Cloud Healthcare API to write to your BigQuery table, you must give the Cloud Healthcare API service account the bigquery.dataEditor role. The service account is: `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The PROJECT_NUMBER identifies the project that the DICOM store resides in. To get the project number, go to the Cloud Console Dashboard. It is recommended to not have a custom schema in the destination table which could conflict with the schema created by the Cloud Healthcare API. Instance deletions are not applied to the destination table. The destination's table schema will be automatically updated in case a new instance's data is incompatible with the current schema. The schema should not be updated manually as this can cause incompatibilies that cannot be resolved automatically. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any instance that generates more than 1 MB of BigQuery data will not be streamed. If an instance cannot be streamed to BigQuery, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html index 310040f8f5a..4786ad01547 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html @@ -160,7 +160,7 @@Instance Methods
Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#search), [STU3](https://hl7.org/fhir/STU3/http.html#search), [R4](https://hl7.org/fhir/R4/http.html#search), [R5](https://hl7.org/fhir/R5/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](https://hl7.org/fhir/DSTU2/search.html), [STU3](https://hl7.org/fhir/STU3/search.html), [R4](https://hl7.org/fhir/R4/search.html), [R5](https://hl7.org/fhir/R5/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](https://hl7.org/fhir/STU3/searchparameter-registry.html), [R4](https://hl7.org/fhir/R4/searchparameter-registry.html), [R5](https://hl7.org/fhir/R5/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `recurse` (DSTU2 and STU3) or `:iterate` (R4 and R5). Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. The server might return fewer resources than requested to prevent excessively large responses. If there are additional results, the returned `Bundle` contains a link of `relation` "next", which has a `_page_token` parameter for an opaque pagination token that can be used to retrieve the next page. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changed, and the time when the change reflects in search results. The only exception is resource identifier data, which is indexed synchronously as a special index. As a result, searching using resource identifier is not subject to indexing delay. To use the special synchronous index, the search term for identifier should be in the pattern `identifier=[system]|[value]` or `identifier=[value]`, and any of the following search result parameters can be used: * `_count` * `_include` * `_revinclude` * `_summary` * `_elements` If your query contains any other search parameters, the standard asynchronous index will be used instead. Note that searching against the special index is optimized for resolving a small number of matches. The search isn't optimized if your identifier search criteria matches a large number (i.e. more than 2,000) of resources. For a search query that will match a large number of resources, you can avoiding using the special synchronous index by including an additional `_sort` parameter in your query. Use `_sort=-_lastUpdated` if you want to keep the default sorting order. Note: The special synchronous identifier index are currently disabled for DocumentReference and DocumentManifest searches. For samples and detailed information, see [Searching for FHIR resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-search) and [Advanced FHIR search features](https://cloud.google.com/healthcare/docs/how-tos/fhir-advanced-search).
-
update(name, body=None, x__xgafv=None)Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update), [R5](https://hl7.org/fhir/R5/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. In R5, the conditional update interaction If-None-Match is supported, including the wildcard behaviour. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).
+Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update), [R5](https://hl7.org/fhir/R5/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The conditional update interaction If-None-Match is supported, including the wildcard behaviour, as defined by the R5 spec. This functionality is supported in R4 and R5. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).
Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#vread), [STU3](https://hl7.org/fhir/STU3/http.html#vread), [R4](https://hl7.org/fhir/R4/http.html#vread), [R5](https://hl7.org/fhir/R5/http.html#vread)). On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `vread`, see [Retrieving a FHIR resource version](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_version).
@@ -991,7 +991,7 @@Method Details
update(name, body=None, x__xgafv=None)-Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update), [R5](https://hl7.org/fhir/R5/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. In R5, the conditional update interaction If-None-Match is supported, including the wildcard behaviour. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource). +Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update), [R5](https://hl7.org/fhir/R5/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The conditional update interaction If-None-Match is supported, including the wildcard behaviour, as defined by the R5 spec. This functionality is supported in R4 and R5. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource). Args: name: string, Required. The name of the resource to update. (required) diff --git a/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html index fe1e747a6e9..c969a0ecb69 100644 --- a/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html +++ b/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html @@ -82,7 +82,7 @@Instance Methods
Deletes a product input from your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
-
insert(parent, body=None, dataSource=None, x__xgafv=None)[Uploads a product input to your Merchant Center account](/merchant/api/guides/products/overview#upload-product-input). You must have a products data source to be able to insert a product. The unique identifier of the data source is passed as a query parameter in the request URL. If an input with the same contentLanguage, offerId, and dataSource already exists, this method replaces that entry. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
+[Uploads a product input to your Merchant Center account](/merchant/api/guides/products/overview#upload-product-input). You must have a products [data source](/merchant/api/guides/data-sources/overview) to be able to insert a product. The unique identifier of the data source is passed as a query parameter in the request URL. If a product input with the same contentLanguage, offerId, and dataSource already exists, then the product input inserted by this method replaces that entry. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
patch(name, body=None, dataSource=None, updateMask=None, x__xgafv=None)Updates the existing product input in your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
@@ -113,7 +113,7 @@Method Details
insert(parent, body=None, dataSource=None, x__xgafv=None)-[Uploads a product input to your Merchant Center account](/merchant/api/guides/products/overview#upload-product-input). You must have a products data source to be able to insert a product. The unique identifier of the data source is passed as a query parameter in the request URL. If an input with the same contentLanguage, offerId, and dataSource already exists, this method replaces that entry. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. +[Uploads a product input to your Merchant Center account](/merchant/api/guides/products/overview#upload-product-input). You must have a products [data source](/merchant/api/guides/data-sources/overview) to be able to insert a product. The unique identifier of the data source is passed as a query parameter in the request URL. If a product input with the same contentLanguage, offerId, and dataSource already exists, then the product input inserted by this method replaces that entry. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. Args: parent: string, Required. The account where this product will be inserted. Format: `accounts/{account}` (required) @@ -125,14 +125,14 @@Method Details
"additionalImageLinks": [ # Additional URLs of images of the item. "A String", ], - "adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387). + "adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA, discouraged otherwise. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387). "adsLabels": [ # Similar to ads_grouping, but only works on CPC. "A String", ], "adsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product ads. "adult": True or False, # Set to true if the item is targeted towards adults. "ageGroup": "A String", # Target [age group](https://support.google.com/merchants/answer/6324463) of the item. - "autoPricingMinPrice": { # The price represented as a number and currency. # A safeguard in the [automated discounts] (https://support.google.com/merchants/answer/10295759) and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability. + "autoPricingMinPrice": { # The price represented as a number and currency. # A safeguard in the [automated discounts] (https://support.google.com/merchants/answer/10295759) and ["dynamic promotions"](https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability. "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). }, @@ -206,7 +206,7 @@Method Details
"gtin": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead. "A String", ], - "gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. + "gtins": [ # A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. "A String", ], "identifierExists": True or False, # Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided. @@ -423,7 +423,7 @@Method Details
"value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. }, ], - "feedLabel": "A String", # Required. Immutable. The label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087). + "feedLabel": "A String", # Required. Immutable. The feed label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087). "name": "A String", # Identifier. The name of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product input name is `accounts/123/productInputs/online~en~US~sku123` "offerId": "A String", # Required. Immutable. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the [products data specification](https://support.google.com/merchants/answer/188494#id) for details. "product": "A String", # Output only. The name of the processed product. Format: `accounts/{account}/products/{product}` @@ -444,14 +444,14 @@Method Details
"additionalImageLinks": [ # Additional URLs of images of the item. "A String", ], - "adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387). + "adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA, discouraged otherwise. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387). "adsLabels": [ # Similar to ads_grouping, but only works on CPC. "A String", ], "adsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product ads. "adult": True or False, # Set to true if the item is targeted towards adults. "ageGroup": "A String", # Target [age group](https://support.google.com/merchants/answer/6324463) of the item. - "autoPricingMinPrice": { # The price represented as a number and currency. # A safeguard in the [automated discounts] (https://support.google.com/merchants/answer/10295759) and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability. + "autoPricingMinPrice": { # The price represented as a number and currency. # A safeguard in the [automated discounts] (https://support.google.com/merchants/answer/10295759) and ["dynamic promotions"](https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability. "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). }, @@ -525,7 +525,7 @@Method Details
"gtin": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead. "A String", ], - "gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. + "gtins": [ # A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. "A String", ], "identifierExists": True or False, # Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided. @@ -742,7 +742,7 @@Method Details
"value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. }, ], - "feedLabel": "A String", # Required. Immutable. The label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087). + "feedLabel": "A String", # Required. Immutable. The feed label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087). "name": "A String", # Identifier. The name of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product input name is `accounts/123/productInputs/online~en~US~sku123` "offerId": "A String", # Required. Immutable. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the [products data specification](https://support.google.com/merchants/answer/188494#id) for details. "product": "A String", # Output only. The name of the processed product. Format: `accounts/{account}/products/{product}` @@ -764,14 +764,14 @@Method Details
"additionalImageLinks": [ # Additional URLs of images of the item. "A String", ], - "adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387). + "adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA, discouraged otherwise. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387). "adsLabels": [ # Similar to ads_grouping, but only works on CPC. "A String", ], "adsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product ads. "adult": True or False, # Set to true if the item is targeted towards adults. "ageGroup": "A String", # Target [age group](https://support.google.com/merchants/answer/6324463) of the item. - "autoPricingMinPrice": { # The price represented as a number and currency. # A safeguard in the [automated discounts] (https://support.google.com/merchants/answer/10295759) and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability. + "autoPricingMinPrice": { # The price represented as a number and currency. # A safeguard in the [automated discounts] (https://support.google.com/merchants/answer/10295759) and ["dynamic promotions"](https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability. "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). }, @@ -845,7 +845,7 @@Method Details
"gtin": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead. "A String", ], - "gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. + "gtins": [ # A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. "A String", ], "identifierExists": True or False, # Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided. @@ -1062,7 +1062,7 @@Method Details
"value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. }, ], - "feedLabel": "A String", # Required. Immutable. The label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087). + "feedLabel": "A String", # Required. Immutable. The feed label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087). "name": "A String", # Identifier. The name of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product input name is `accounts/123/productInputs/online~en~US~sku123` "offerId": "A String", # Required. Immutable. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the [products data specification](https://support.google.com/merchants/answer/188494#id) for details. "product": "A String", # Output only. The name of the processed product. Format: `accounts/{account}/products/{product}` @@ -1084,14 +1084,14 @@Method Details
"additionalImageLinks": [ # Additional URLs of images of the item. "A String", ], - "adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387). + "adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA, discouraged otherwise. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387). "adsLabels": [ # Similar to ads_grouping, but only works on CPC. "A String", ], "adsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product ads. "adult": True or False, # Set to true if the item is targeted towards adults. "ageGroup": "A String", # Target [age group](https://support.google.com/merchants/answer/6324463) of the item. - "autoPricingMinPrice": { # The price represented as a number and currency. # A safeguard in the [automated discounts] (https://support.google.com/merchants/answer/10295759) and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability. + "autoPricingMinPrice": { # The price represented as a number and currency. # A safeguard in the [automated discounts] (https://support.google.com/merchants/answer/10295759) and ["dynamic promotions"](https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability. "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). }, @@ -1165,7 +1165,7 @@Method Details
"gtin": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead. "A String", ], - "gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. + "gtins": [ # A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. "A String", ], "identifierExists": True or False, # Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided. @@ -1382,7 +1382,7 @@Method Details
"value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. }, ], - "feedLabel": "A String", # Required. Immutable. The label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087). + "feedLabel": "A String", # Required. Immutable. The feed label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087). "name": "A String", # Identifier. The name of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` consists of 4 parts: `channel~content_language~feed_label~offer_id` example for product input name is `accounts/123/productInputs/online~en~US~sku123` "offerId": "A String", # Required. Immutable. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the [products data specification](https://support.google.com/merchants/answer/188494#id) for details. "product": "A String", # Output only. The name of the processed product. Format: `accounts/{account}/products/{product}` diff --git a/docs/dyn/merchantapi_products_v1beta.accounts.products.html b/docs/dyn/merchantapi_products_v1beta.accounts.products.html index b2b279a34b2..3baed065169 100644 --- a/docs/dyn/merchantapi_products_v1beta.accounts.products.html +++ b/docs/dyn/merchantapi_products_v1beta.accounts.products.html @@ -111,14 +111,14 @@Method Details
"additionalImageLinks": [ # Additional URLs of images of the item. "A String", ], - "adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387). + "adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA, discouraged otherwise. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387). "adsLabels": [ # Similar to ads_grouping, but only works on CPC. "A String", ], "adsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product ads. "adult": True or False, # Set to true if the item is targeted towards adults. "ageGroup": "A String", # Target [age group](https://support.google.com/merchants/answer/6324463) of the item. - "autoPricingMinPrice": { # The price represented as a number and currency. # A safeguard in the [automated discounts] (https://support.google.com/merchants/answer/10295759) and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability. + "autoPricingMinPrice": { # The price represented as a number and currency. # A safeguard in the [automated discounts] (https://support.google.com/merchants/answer/10295759) and ["dynamic promotions"](https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability. "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). }, @@ -192,7 +192,7 @@Method Details
"gtin": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead. "A String", ], - "gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. + "gtins": [ # A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. "A String", ], "identifierExists": True or False, # Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided. @@ -471,7 +471,7 @@Method Details
Args: parent: string, Required. The account to list processed products for. Format: `accounts/{account}` (required) - pageSize: integer, The maximum number of products 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, the maximum number of products will be returned. + pageSize: integer, The maximum number of products 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, the default page size of 25 products will be returned. pageToken: string, A page token, received from a previous `ListProducts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProducts` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values @@ -489,14 +489,14 @@Method Details
"additionalImageLinks": [ # Additional URLs of images of the item. "A String", ], - "adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387). + "adsGrouping": "A String", # Used to group items in an arbitrary way. Only for CPA, discouraged otherwise. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387). "adsLabels": [ # Similar to ads_grouping, but only works on CPC. "A String", ], "adsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product ads. "adult": True or False, # Set to true if the item is targeted towards adults. "ageGroup": "A String", # Target [age group](https://support.google.com/merchants/answer/6324463) of the item. - "autoPricingMinPrice": { # The price represented as a number and currency. # A safeguard in the [automated discounts] (https://support.google.com/merchants/answer/10295759) and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability. + "autoPricingMinPrice": { # The price represented as a number and currency. # A safeguard in the [automated discounts] (https://support.google.com/merchants/answer/10295759) and ["dynamic promotions"](https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability. "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). }, @@ -570,7 +570,7 @@Method Details
"gtin": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. Deprecated: Use `gtins` instead. "A String", ], - "gtins": [ # Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. + "gtins": [ # A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. "A String", ], "identifierExists": True or False, # Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided. diff --git a/docs/dyn/merchantapi_reviews_v1beta.accounts.merchantReviews.html b/docs/dyn/merchantapi_reviews_v1beta.accounts.merchantReviews.html index 93b00915582..86cae54e889 100644 --- a/docs/dyn/merchantapi_reviews_v1beta.accounts.merchantReviews.html +++ b/docs/dyn/merchantapi_reviews_v1beta.accounts.merchantReviews.html @@ -131,7 +131,17 @@Method Details
An object of the form: { # A review for a merchant. For more information, see [Introduction to Merchant Review Feeds](https://developers.google.com/merchant-review-feeds) - "attributes": { # Attributes. # Optional. A list of merchant review attributes. + "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. + { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. + "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. + # Object with schema name: CustomAttribute + ], + "name": "A String", # The name of the attribute. + "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. + }, + ], + "dataSource": "A String", # Output only. The primary data source of the merchant review. + "merchantReviewAttributes": { # Attributes. # Optional. A list of merchant review attributes. "collectionMethod": "A String", # Optional. The method used to collect the review. "content": "A String", # Required. This should be any freeform text provided by the user and should not be truncated. If multiple responses to different questions are provided, all responses should be included, with the minimal context for the responses to make sense. Context should not be provided if questions were left unanswered. "isAnonymous": True or False, # Optional. Set to true if the reviewer should remain anonymous. @@ -149,16 +159,6 @@Method Details
"reviewerUsername": "A String", # Optional. Display name of the review author. "title": "A String", # Optional. The title of the review. }, - "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. - { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. - "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. - # Object with schema name: CustomAttribute - ], - "name": "A String", # The name of the attribute. - "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. - }, - ], - "dataSource": "A String", # Output only. The primary data source of the merchant review. "merchantReviewId": "A String", # Required. The user provided merchant review ID to uniquely identify the merchant review. "merchantReviewStatus": { # The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously. # Output only. The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously. "createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. @@ -195,7 +195,17 @@Method Details
The object takes the form of: { # A review for a merchant. For more information, see [Introduction to Merchant Review Feeds](https://developers.google.com/merchant-review-feeds) - "attributes": { # Attributes. # Optional. A list of merchant review attributes. + "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. + { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. + "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. + # Object with schema name: CustomAttribute + ], + "name": "A String", # The name of the attribute. + "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. + }, + ], + "dataSource": "A String", # Output only. The primary data source of the merchant review. + "merchantReviewAttributes": { # Attributes. # Optional. A list of merchant review attributes. "collectionMethod": "A String", # Optional. The method used to collect the review. "content": "A String", # Required. This should be any freeform text provided by the user and should not be truncated. If multiple responses to different questions are provided, all responses should be included, with the minimal context for the responses to make sense. Context should not be provided if questions were left unanswered. "isAnonymous": True or False, # Optional. Set to true if the reviewer should remain anonymous. @@ -213,16 +223,6 @@Method Details
"reviewerUsername": "A String", # Optional. Display name of the review author. "title": "A String", # Optional. The title of the review. }, - "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. - { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. - "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. - # Object with schema name: CustomAttribute - ], - "name": "A String", # The name of the attribute. - "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. - }, - ], - "dataSource": "A String", # Output only. The primary data source of the merchant review. "merchantReviewId": "A String", # Required. The user provided merchant review ID to uniquely identify the merchant review. "merchantReviewStatus": { # The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously. # Output only. The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously. "createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. @@ -258,7 +258,17 @@Method Details
An object of the form: { # A review for a merchant. For more information, see [Introduction to Merchant Review Feeds](https://developers.google.com/merchant-review-feeds) - "attributes": { # Attributes. # Optional. A list of merchant review attributes. + "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. + { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. + "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. + # Object with schema name: CustomAttribute + ], + "name": "A String", # The name of the attribute. + "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. + }, + ], + "dataSource": "A String", # Output only. The primary data source of the merchant review. + "merchantReviewAttributes": { # Attributes. # Optional. A list of merchant review attributes. "collectionMethod": "A String", # Optional. The method used to collect the review. "content": "A String", # Required. This should be any freeform text provided by the user and should not be truncated. If multiple responses to different questions are provided, all responses should be included, with the minimal context for the responses to make sense. Context should not be provided if questions were left unanswered. "isAnonymous": True or False, # Optional. Set to true if the reviewer should remain anonymous. @@ -276,16 +286,6 @@Method Details
"reviewerUsername": "A String", # Optional. Display name of the review author. "title": "A String", # Optional. The title of the review. }, - "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. - { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. - "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. - # Object with schema name: CustomAttribute - ], - "name": "A String", # The name of the attribute. - "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. - }, - ], - "dataSource": "A String", # Output only. The primary data source of the merchant review. "merchantReviewId": "A String", # Required. The user provided merchant review ID to uniquely identify the merchant review. "merchantReviewStatus": { # The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously. # Output only. The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously. "createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. @@ -331,7 +331,17 @@Method Details
{ # Response message for the `ListMerchantsReview` method. "merchantReviews": [ # The merchant review. { # A review for a merchant. For more information, see [Introduction to Merchant Review Feeds](https://developers.google.com/merchant-review-feeds) - "attributes": { # Attributes. # Optional. A list of merchant review attributes. + "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. + { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. + "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. + # Object with schema name: CustomAttribute + ], + "name": "A String", # The name of the attribute. + "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. + }, + ], + "dataSource": "A String", # Output only. The primary data source of the merchant review. + "merchantReviewAttributes": { # Attributes. # Optional. A list of merchant review attributes. "collectionMethod": "A String", # Optional. The method used to collect the review. "content": "A String", # Required. This should be any freeform text provided by the user and should not be truncated. If multiple responses to different questions are provided, all responses should be included, with the minimal context for the responses to make sense. Context should not be provided if questions were left unanswered. "isAnonymous": True or False, # Optional. Set to true if the reviewer should remain anonymous. @@ -349,16 +359,6 @@Method Details
"reviewerUsername": "A String", # Optional. Display name of the review author. "title": "A String", # Optional. The title of the review. }, - "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion. - { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. - "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. - # Object with schema name: CustomAttribute - ], - "name": "A String", # The name of the attribute. - "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. - }, - ], - "dataSource": "A String", # Output only. The primary data source of the merchant review. "merchantReviewId": "A String", # Required. The user provided merchant review ID to uniquely identify the merchant review. "merchantReviewStatus": { # The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously. # Output only. The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously. "createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. diff --git a/docs/dyn/merchantapi_reviews_v1beta.accounts.productReviews.html b/docs/dyn/merchantapi_reviews_v1beta.accounts.productReviews.html index e6f79bfda91..c5550daa852 100644 --- a/docs/dyn/merchantapi_reviews_v1beta.accounts.productReviews.html +++ b/docs/dyn/merchantapi_reviews_v1beta.accounts.productReviews.html @@ -131,7 +131,18 @@Method Details
An object of the form: { # A review for a product. For more information, see [Introduction to Product Review Feeds](https://developers.google.com/product-review-feeds) - "attributes": { # Attributes. # Optional. A list of product review attributes. + "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. + { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. + "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. + # Object with schema name: CustomAttribute + ], + "name": "A String", # The name of the attribute. + "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. + }, + ], + "dataSource": "A String", # Output only. The primary data source of the product review. + "name": "A String", # Identifier. The name of the product review. Format: `"{productreview.name=accounts/{account}/productReviews/{productReview}}"` + "productReviewAttributes": { # Attributes. # Optional. A list of product review attributes. "aggregatorName": "A String", # Optional. The name of the aggregator of the product reviews. A publisher may use a reviews aggregator to manage reviews and provide the feeds. This element indicates the use of an aggregator and contains information about the aggregator. "asins": [ # Optional. Contains ASINs (Amazon Standard Identification Numbers) associated with a product. "A String", @@ -187,17 +198,6 @@Method Details
"title": "A String", # Optional. The title of the review. "transactionId": "A String", # Optional. A permanent, unique identifier for the transaction associated with the review in the publisher's system. This ID can be used to indicate that multiple reviews are associated with the same transaction. }, - "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. - { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. - "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. - # Object with schema name: CustomAttribute - ], - "name": "A String", # The name of the attribute. - "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. - }, - ], - "dataSource": "A String", # Output only. The primary data source of the product review. - "name": "A String", # Identifier. The name of the product review. Format: `"{productreview.name=accounts/{account}/productReviews/{productReview}}"` "productReviewId": "A String", # Required. The permanent, unique identifier for the product review in the publisher’s system. "productReviewStatus": { # Product review status. # Output only. The status of a product review, data validation issues, that is, information about a product review computed asynchronously. "createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. @@ -233,7 +233,18 @@Method Details
The object takes the form of: { # A review for a product. For more information, see [Introduction to Product Review Feeds](https://developers.google.com/product-review-feeds) - "attributes": { # Attributes. # Optional. A list of product review attributes. + "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. + { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. + "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. + # Object with schema name: CustomAttribute + ], + "name": "A String", # The name of the attribute. + "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. + }, + ], + "dataSource": "A String", # Output only. The primary data source of the product review. + "name": "A String", # Identifier. The name of the product review. Format: `"{productreview.name=accounts/{account}/productReviews/{productReview}}"` + "productReviewAttributes": { # Attributes. # Optional. A list of product review attributes. "aggregatorName": "A String", # Optional. The name of the aggregator of the product reviews. A publisher may use a reviews aggregator to manage reviews and provide the feeds. This element indicates the use of an aggregator and contains information about the aggregator. "asins": [ # Optional. Contains ASINs (Amazon Standard Identification Numbers) associated with a product. "A String", @@ -289,17 +300,6 @@Method Details
"title": "A String", # Optional. The title of the review. "transactionId": "A String", # Optional. A permanent, unique identifier for the transaction associated with the review in the publisher's system. This ID can be used to indicate that multiple reviews are associated with the same transaction. }, - "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. - { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. - "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. - # Object with schema name: CustomAttribute - ], - "name": "A String", # The name of the attribute. - "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. - }, - ], - "dataSource": "A String", # Output only. The primary data source of the product review. - "name": "A String", # Identifier. The name of the product review. Format: `"{productreview.name=accounts/{account}/productReviews/{productReview}}"` "productReviewId": "A String", # Required. The permanent, unique identifier for the product review in the publisher’s system. "productReviewStatus": { # Product review status. # Output only. The status of a product review, data validation issues, that is, information about a product review computed asynchronously. "createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. @@ -334,7 +334,18 @@Method Details
An object of the form: { # A review for a product. For more information, see [Introduction to Product Review Feeds](https://developers.google.com/product-review-feeds) - "attributes": { # Attributes. # Optional. A list of product review attributes. + "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. + { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. + "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. + # Object with schema name: CustomAttribute + ], + "name": "A String", # The name of the attribute. + "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. + }, + ], + "dataSource": "A String", # Output only. The primary data source of the product review. + "name": "A String", # Identifier. The name of the product review. Format: `"{productreview.name=accounts/{account}/productReviews/{productReview}}"` + "productReviewAttributes": { # Attributes. # Optional. A list of product review attributes. "aggregatorName": "A String", # Optional. The name of the aggregator of the product reviews. A publisher may use a reviews aggregator to manage reviews and provide the feeds. This element indicates the use of an aggregator and contains information about the aggregator. "asins": [ # Optional. Contains ASINs (Amazon Standard Identification Numbers) associated with a product. "A String", @@ -390,17 +401,6 @@Method Details
"title": "A String", # Optional. The title of the review. "transactionId": "A String", # Optional. A permanent, unique identifier for the transaction associated with the review in the publisher's system. This ID can be used to indicate that multiple reviews are associated with the same transaction. }, - "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. - { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. - "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. - # Object with schema name: CustomAttribute - ], - "name": "A String", # The name of the attribute. - "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. - }, - ], - "dataSource": "A String", # Output only. The primary data source of the product review. - "name": "A String", # Identifier. The name of the product review. Format: `"{productreview.name=accounts/{account}/productReviews/{productReview}}"` "productReviewId": "A String", # Required. The permanent, unique identifier for the product review in the publisher’s system. "productReviewStatus": { # Product review status. # Output only. The status of a product review, data validation issues, that is, information about a product review computed asynchronously. "createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. @@ -446,7 +446,18 @@Method Details
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "productReviews": [ # The product review. { # A review for a product. For more information, see [Introduction to Product Review Feeds](https://developers.google.com/product-review-feeds) - "attributes": { # Attributes. # Optional. A list of product review attributes. + "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. + { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. + "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. + # Object with schema name: CustomAttribute + ], + "name": "A String", # The name of the attribute. + "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. + }, + ], + "dataSource": "A String", # Output only. The primary data source of the product review. + "name": "A String", # Identifier. The name of the product review. Format: `"{productreview.name=accounts/{account}/productReviews/{productReview}}"` + "productReviewAttributes": { # Attributes. # Optional. A list of product review attributes. "aggregatorName": "A String", # Optional. The name of the aggregator of the product reviews. A publisher may use a reviews aggregator to manage reviews and provide the feeds. This element indicates the use of an aggregator and contains information about the aggregator. "asins": [ # Optional. Contains ASINs (Amazon Standard Identification Numbers) associated with a product. "A String", @@ -502,17 +513,6 @@Method Details
"title": "A String", # Optional. The title of the review. "transactionId": "A String", # Optional. A permanent, unique identifier for the transaction associated with the review in the publisher's system. This ID can be used to indicate that multiple reviews are associated with the same transaction. }, - "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. - { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. - "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. - # Object with schema name: CustomAttribute - ], - "name": "A String", # The name of the attribute. - "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty. - }, - ], - "dataSource": "A String", # Output only. The primary data source of the product review. - "name": "A String", # Identifier. The name of the product review. Format: `"{productreview.name=accounts/{account}/productReviews/{productReview}}"` "productReviewId": "A String", # Required. The permanent, unique identifier for the product review in the publisher’s system. "productReviewStatus": { # Product review status. # Output only. The status of a product review, data validation issues, that is, information about a product review computed asynchronously. "createTime": "A String", # Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html index a7bc625ae74..d7d079d1bcd 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html @@ -485,6 +485,7 @@Method Details
"smbiosUuid": "A String", # SMBIOS UUID. }, "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc. + "cpuManufacturer": "A String", # Optional. CPU manufacturer, e.g., "Intel", "AMD". "cpuName": "A String", # CPU name, e.g., "Intel Xeon E5-2690", "AMD EPYC 7571" etc. "cpuSocketCount": 42, # Number of processor sockets allocated to the machine. "firmwareType": "A String", # Firmware type. @@ -1342,6 +1343,7 @@Method Details
"smbiosUuid": "A String", # SMBIOS UUID. }, "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc. + "cpuManufacturer": "A String", # Optional. CPU manufacturer, e.g., "Intel", "AMD". "cpuName": "A String", # CPU name, e.g., "Intel Xeon E5-2690", "AMD EPYC 7571" etc. "cpuSocketCount": 42, # Number of processor sockets allocated to the machine. "firmwareType": "A String", # Firmware type. @@ -2231,6 +2233,7 @@Method Details
"smbiosUuid": "A String", # SMBIOS UUID. }, "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc. + "cpuManufacturer": "A String", # Optional. CPU manufacturer, e.g., "Intel", "AMD". "cpuName": "A String", # CPU name, e.g., "Intel Xeon E5-2690", "AMD EPYC 7571" etc. "cpuSocketCount": 42, # Number of processor sockets allocated to the machine. "firmwareType": "A String", # Firmware type. @@ -3101,6 +3104,7 @@Method Details
"smbiosUuid": "A String", # SMBIOS UUID. }, "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc. + "cpuManufacturer": "A String", # Optional. CPU manufacturer, e.g., "Intel", "AMD". "cpuName": "A String", # CPU name, e.g., "Intel Xeon E5-2690", "AMD EPYC 7571" etc. "cpuSocketCount": 42, # Number of processor sockets allocated to the machine. "firmwareType": "A String", # Firmware type. @@ -3973,6 +3977,7 @@Method Details
"smbiosUuid": "A String", # SMBIOS UUID. }, "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc. + "cpuManufacturer": "A String", # Optional. CPU manufacturer, e.g., "Intel", "AMD". "cpuName": "A String", # CPU name, e.g., "Intel Xeon E5-2690", "AMD EPYC 7571" etc. "cpuSocketCount": 42, # Number of processor sockets allocated to the machine. "firmwareType": "A String", # Firmware type. @@ -4825,6 +4830,7 @@Method Details
"smbiosUuid": "A String", # SMBIOS UUID. }, "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc. + "cpuManufacturer": "A String", # Optional. CPU manufacturer, e.g., "Intel", "AMD". "cpuName": "A String", # CPU name, e.g., "Intel Xeon E5-2690", "AMD EPYC 7571" etc. "cpuSocketCount": 42, # Number of processor sockets allocated to the machine. "firmwareType": "A String", # Firmware type. @@ -5572,6 +5578,7 @@Method Details
"smbiosUuid": "A String", # SMBIOS UUID. }, "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc. + "cpuManufacturer": "A String", # Optional. CPU manufacturer, e.g., "Intel", "AMD". "cpuName": "A String", # CPU name, e.g., "Intel Xeon E5-2690", "AMD EPYC 7571" etc. "cpuSocketCount": 42, # Number of processor sockets allocated to the machine. "firmwareType": "A String", # Firmware type. diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html index 821234d015e..9f837515289 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html @@ -274,6 +274,7 @@Method Details
"smbiosUuid": "A String", # SMBIOS UUID. }, "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc. + "cpuManufacturer": "A String", # Optional. CPU manufacturer, e.g., "Intel", "AMD". "cpuName": "A String", # CPU name, e.g., "Intel Xeon E5-2690", "AMD EPYC 7571" etc. "cpuSocketCount": 42, # Number of processor sockets allocated to the machine. "firmwareType": "A String", # Firmware type. @@ -998,6 +999,7 @@Method Details
"smbiosUuid": "A String", # SMBIOS UUID. }, "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc. + "cpuManufacturer": "A String", # Optional. CPU manufacturer, e.g., "Intel", "AMD". "cpuName": "A String", # CPU name, e.g., "Intel Xeon E5-2690", "AMD EPYC 7571" etc. "cpuSocketCount": 42, # Number of processor sockets allocated to the machine. "firmwareType": "A String", # Firmware type. diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html b/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html index 8e915567898..ae553e4d7ba 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html @@ -137,12 +137,24 @@Method Details
"from": { # Describes properties of one or more sources of a request. # Optional. Describes properties of a source of a request. "notSources": [ # Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified. { # Describes the properties of a single source. - "ipBlocks": [ # Optional. A list of IPs or CIDRs to match against the source IP of a request. Limited to 5 ip_blocks. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 5 ip_blocks. { # Represents a range of IP Addresses. "length": 42, # Required. The length of the address range. "prefix": "A String", # Required. The address prefix. }, ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 5 principals. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 5 resources. { # Describes the properties of a client VM resource accessing the internal application load balancers. "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. @@ -163,12 +175,24 @@Method Details
], "sources": [ # Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 1 source. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match. { # Describes the properties of a single source. - "ipBlocks": [ # Optional. A list of IPs or CIDRs to match against the source IP of a request. Limited to 5 ip_blocks. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 5 ip_blocks. { # Represents a range of IP Addresses. "length": 42, # Required. The length of the address range. "prefix": "A String", # Required. The address prefix. }, ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 5 principals. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 5 resources. { # Describes the properties of a client VM resource accessing the internal application load balancers. "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. @@ -383,12 +407,24 @@Method Details
"from": { # Describes properties of one or more sources of a request. # Optional. Describes properties of a source of a request. "notSources": [ # Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified. { # Describes the properties of a single source. - "ipBlocks": [ # Optional. A list of IPs or CIDRs to match against the source IP of a request. Limited to 5 ip_blocks. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 5 ip_blocks. { # Represents a range of IP Addresses. "length": 42, # Required. The length of the address range. "prefix": "A String", # Required. The address prefix. }, ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 5 principals. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 5 resources. { # Describes the properties of a client VM resource accessing the internal application load balancers. "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. @@ -409,12 +445,24 @@Method Details
], "sources": [ # Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 1 source. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match. { # Describes the properties of a single source. - "ipBlocks": [ # Optional. A list of IPs or CIDRs to match against the source IP of a request. Limited to 5 ip_blocks. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 5 ip_blocks. { # Represents a range of IP Addresses. "length": 42, # Required. The length of the address range. "prefix": "A String", # Required. The address prefix. }, ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 5 principals. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 5 resources. { # Describes the properties of a client VM resource accessing the internal application load balancers. "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. @@ -617,12 +665,24 @@Method Details
"from": { # Describes properties of one or more sources of a request. # Optional. Describes properties of a source of a request. "notSources": [ # Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified. { # Describes the properties of a single source. - "ipBlocks": [ # Optional. A list of IPs or CIDRs to match against the source IP of a request. Limited to 5 ip_blocks. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 5 ip_blocks. { # Represents a range of IP Addresses. "length": 42, # Required. The length of the address range. "prefix": "A String", # Required. The address prefix. }, ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 5 principals. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 5 resources. { # Describes the properties of a client VM resource accessing the internal application load balancers. "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. @@ -643,12 +703,24 @@Method Details
], "sources": [ # Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 1 source. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match. { # Describes the properties of a single source. - "ipBlocks": [ # Optional. A list of IPs or CIDRs to match against the source IP of a request. Limited to 5 ip_blocks. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 5 ip_blocks. { # Represents a range of IP Addresses. "length": 42, # Required. The length of the address range. "prefix": "A String", # Required. The address prefix. }, ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 5 principals. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 5 resources. { # Describes the properties of a client VM resource accessing the internal application load balancers. "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. @@ -812,12 +884,24 @@Method Details
"from": { # Describes properties of one or more sources of a request. # Optional. Describes properties of a source of a request. "notSources": [ # Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified. { # Describes the properties of a single source. - "ipBlocks": [ # Optional. A list of IPs or CIDRs to match against the source IP of a request. Limited to 5 ip_blocks. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 5 ip_blocks. { # Represents a range of IP Addresses. "length": 42, # Required. The length of the address range. "prefix": "A String", # Required. The address prefix. }, ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 5 principals. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 5 resources. { # Describes the properties of a client VM resource accessing the internal application load balancers. "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. @@ -838,12 +922,24 @@Method Details
], "sources": [ # Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 1 source. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match. { # Describes the properties of a single source. - "ipBlocks": [ # Optional. A list of IPs or CIDRs to match against the source IP of a request. Limited to 5 ip_blocks. + "ipBlocks": [ # Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 5 ip_blocks. { # Represents a range of IP Addresses. "length": 42, # Required. The length of the address range. "prefix": "A String", # Required. The address prefix. }, ], + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 5 principals. + { # Describes the properties of a principal to be matched against. + "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. + "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + }, + "principalSelector": "A String", # Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN. + }, + ], "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 5 resources. { # Describes the properties of a client VM resource accessing the internal application load balancers. "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request. diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.backendAuthenticationConfigs.html b/docs/dyn/networksecurity_v1beta1.projects.locations.backendAuthenticationConfigs.html index 9b709c2cb86..2094cf10092 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.backendAuthenticationConfigs.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.backendAuthenticationConfigs.html @@ -110,7 +110,7 @@Method Details
body: object, The request body. The object takes the form of: -{ # BackendAuthenticationConfig message groups the TrustConfig together with other settings that control how the load balancer authenticates, and expresses its identity to, the backend: * `trustConfig` is the attached TrustConfig. * `wellKnownRoots` indicates whether the load balance should trust backend server certificates that are issued by public certificate authorities, in addition to certificates trusted by the TrustConfig. * `clientCertificate` is a client certificate that the load balancer uses to express its identity to the backend, if the connection to the backend uses mTLS. You can attach the BackendAuthenticationConfig to the load balancer’s BackendService directly determining how that BackendService negotiates TLS. +{ # BackendAuthenticationConfig message groups the TrustConfig together with other settings that control how the load balancer authenticates, and expresses its identity to, the backend: * `trustConfig` is the attached TrustConfig. * `wellKnownRoots` indicates whether the load balance should trust backend server certificates that are issued by public certificate authorities, in addition to certificates trusted by the TrustConfig. * `clientCertificate` is a client certificate that the load balancer uses to express its identity to the backend, if the connection to the backend uses mTLS. You can attach the BackendAuthenticationConfig to the load balancer's BackendService directly determining how that BackendService negotiates TLS. "clientCertificate": "A String", # Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a relative resource path following the form "projects/{project}/locations/{location}/certificates/{certificate}". Used by a BackendService to negotiate mTLS when the backend connection uses TLS and the backend requests a client certificate. Must have a CLIENT_AUTH scope. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. Free-text description of the resource. @@ -204,7 +204,7 @@Method Details
Returns: An object of the form: - { # BackendAuthenticationConfig message groups the TrustConfig together with other settings that control how the load balancer authenticates, and expresses its identity to, the backend: * `trustConfig` is the attached TrustConfig. * `wellKnownRoots` indicates whether the load balance should trust backend server certificates that are issued by public certificate authorities, in addition to certificates trusted by the TrustConfig. * `clientCertificate` is a client certificate that the load balancer uses to express its identity to the backend, if the connection to the backend uses mTLS. You can attach the BackendAuthenticationConfig to the load balancer’s BackendService directly determining how that BackendService negotiates TLS. + { # BackendAuthenticationConfig message groups the TrustConfig together with other settings that control how the load balancer authenticates, and expresses its identity to, the backend: * `trustConfig` is the attached TrustConfig. * `wellKnownRoots` indicates whether the load balance should trust backend server certificates that are issued by public certificate authorities, in addition to certificates trusted by the TrustConfig. * `clientCertificate` is a client certificate that the load balancer uses to express its identity to the backend, if the connection to the backend uses mTLS. You can attach the BackendAuthenticationConfig to the load balancer's BackendService directly determining how that BackendService negotiates TLS. "clientCertificate": "A String", # Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a relative resource path following the form "projects/{project}/locations/{location}/certificates/{certificate}". Used by a BackendService to negotiate mTLS when the backend connection uses TLS and the backend requests a client certificate. Must have a CLIENT_AUTH scope. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. Free-text description of the resource. @@ -237,7 +237,7 @@Method Details
{ # Response returned by the ListBackendAuthenticationConfigs method. "backendAuthenticationConfigs": [ # List of BackendAuthenticationConfig resources. - { # BackendAuthenticationConfig message groups the TrustConfig together with other settings that control how the load balancer authenticates, and expresses its identity to, the backend: * `trustConfig` is the attached TrustConfig. * `wellKnownRoots` indicates whether the load balance should trust backend server certificates that are issued by public certificate authorities, in addition to certificates trusted by the TrustConfig. * `clientCertificate` is a client certificate that the load balancer uses to express its identity to the backend, if the connection to the backend uses mTLS. You can attach the BackendAuthenticationConfig to the load balancer’s BackendService directly determining how that BackendService negotiates TLS. + { # BackendAuthenticationConfig message groups the TrustConfig together with other settings that control how the load balancer authenticates, and expresses its identity to, the backend: * `trustConfig` is the attached TrustConfig. * `wellKnownRoots` indicates whether the load balance should trust backend server certificates that are issued by public certificate authorities, in addition to certificates trusted by the TrustConfig. * `clientCertificate` is a client certificate that the load balancer uses to express its identity to the backend, if the connection to the backend uses mTLS. You can attach the BackendAuthenticationConfig to the load balancer's BackendService directly determining how that BackendService negotiates TLS. "clientCertificate": "A String", # Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a relative resource path following the form "projects/{project}/locations/{location}/certificates/{certificate}". Used by a BackendService to negotiate mTLS when the backend connection uses TLS and the backend requests a client certificate. Must have a CLIENT_AUTH scope. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. Free-text description of the resource. @@ -281,7 +281,7 @@Method Details
body: object, The request body. The object takes the form of: -{ # BackendAuthenticationConfig message groups the TrustConfig together with other settings that control how the load balancer authenticates, and expresses its identity to, the backend: * `trustConfig` is the attached TrustConfig. * `wellKnownRoots` indicates whether the load balance should trust backend server certificates that are issued by public certificate authorities, in addition to certificates trusted by the TrustConfig. * `clientCertificate` is a client certificate that the load balancer uses to express its identity to the backend, if the connection to the backend uses mTLS. You can attach the BackendAuthenticationConfig to the load balancer’s BackendService directly determining how that BackendService negotiates TLS. +{ # BackendAuthenticationConfig message groups the TrustConfig together with other settings that control how the load balancer authenticates, and expresses its identity to, the backend: * `trustConfig` is the attached TrustConfig. * `wellKnownRoots` indicates whether the load balance should trust backend server certificates that are issued by public certificate authorities, in addition to certificates trusted by the TrustConfig. * `clientCertificate` is a client certificate that the load balancer uses to express its identity to the backend, if the connection to the backend uses mTLS. You can attach the BackendAuthenticationConfig to the load balancer's BackendService directly determining how that BackendService negotiates TLS. "clientCertificate": "A String", # Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a relative resource path following the form "projects/{project}/locations/{location}/certificates/{certificate}". Used by a BackendService to negotiate mTLS when the backend connection uses TLS and the backend requests a client certificate. Must have a CLIENT_AUTH scope. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. Free-text description of the resource. diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.clientTlsPolicies.html b/docs/dyn/networksecurity_v1beta1.projects.locations.clientTlsPolicies.html index 4f1e1f81108..42b71e10083 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.clientTlsPolicies.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.clientTlsPolicies.html @@ -133,7 +133,7 @@Method Details
"labels": { # Optional. Set of label tags associated with the resource. "a_key": "A String", }, - "name": "A String", # Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}` + "name": "A String", # Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}` "serverValidationCa": [ # Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. { # Specification of ValidationCA. Defines the mechanism to obtain the Certificate Authority certificate to validate the peer certificate. "certificateProviderInstance": { # Specification of a TLS certificate provider instance. Workloads may have one or more CertificateProvider instances (plugins) and one of them is enabled and configured by specifying this message. Workloads use the values from this message to locate and load the CertificateProvider instance configuration. # The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. @@ -241,7 +241,7 @@Method Details
"labels": { # Optional. Set of label tags associated with the resource. "a_key": "A String", }, - "name": "A String", # Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}` + "name": "A String", # Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}` "serverValidationCa": [ # Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. { # Specification of ValidationCA. Defines the mechanism to obtain the Certificate Authority certificate to validate the peer certificate. "certificateProviderInstance": { # Specification of a TLS certificate provider instance. Workloads may have one or more CertificateProvider instances (plugins) and one of them is enabled and configured by specifying this message. Workloads use the values from this message to locate and load the CertificateProvider instance configuration. # The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. @@ -337,7 +337,7 @@Method Details
"labels": { # Optional. Set of label tags associated with the resource. "a_key": "A String", }, - "name": "A String", # Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}` + "name": "A String", # Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}` "serverValidationCa": [ # Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. { # Specification of ValidationCA. Defines the mechanism to obtain the Certificate Authority certificate to validate the peer certificate. "certificateProviderInstance": { # Specification of a TLS certificate provider instance. Workloads may have one or more CertificateProvider instances (plugins) and one of them is enabled and configured by specifying this message. Workloads use the values from this message to locate and load the CertificateProvider instance configuration. # The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. @@ -375,7 +375,7 @@Method Details
Updates the parameters of a single ClientTlsPolicy. Args: - name: string, Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}` (required) + name: string, Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}` (required) body: object, The request body. The object takes the form of: @@ -393,7 +393,7 @@Method Details
"labels": { # Optional. Set of label tags associated with the resource. "a_key": "A String", }, - "name": "A String", # Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}` + "name": "A String", # Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}` "serverValidationCa": [ # Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. { # Specification of ValidationCA. Defines the mechanism to obtain the Certificate Authority certificate to validate the peer certificate. "certificateProviderInstance": { # Specification of a TLS certificate provider instance. Workloads may have one or more CertificateProvider instances (plugins) and one of them is enabled and configured by specifying this message. Workloads use the values from this message to locate and load the CertificateProvider instance configuration. # The certificate provider instance specification that will be passed to the data plane, which will be used to load necessary credential information. diff --git a/docs/dyn/networkservices_v1.projects.locations.gateways.html b/docs/dyn/networkservices_v1.projects.locations.gateways.html index 8881e544e23..9ca69c22ddf 100644 --- a/docs/dyn/networkservices_v1.projects.locations.gateways.html +++ b/docs/dyn/networkservices_v1.projects.locations.gateways.html @@ -132,7 +132,7 @@Method Details
}, "name": "A String", # Identifier. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`. "network": "A String", # Optional. The relative resource name identifying the VPC network that is using this configuration. For example: `projects/*/global/networks/network-1`. Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'. - "ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. + "ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 5 ports. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. 42, ], "routingMode": "A String", # Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY. @@ -240,7 +240,7 @@Method Details
}, "name": "A String", # Identifier. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`. "network": "A String", # Optional. The relative resource name identifying the VPC network that is using this configuration. For example: `projects/*/global/networks/network-1`. Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'. - "ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. + "ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 5 ports. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. 42, ], "routingMode": "A String", # Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY. @@ -288,7 +288,7 @@Method Details
}, "name": "A String", # Identifier. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`. "network": "A String", # Optional. The relative resource name identifying the VPC network that is using this configuration. For example: `projects/*/global/networks/network-1`. Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'. - "ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. + "ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 5 ports. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. 42, ], "routingMode": "A String", # Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY. @@ -347,7 +347,7 @@Method Details
}, "name": "A String", # Identifier. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`. "network": "A String", # Optional. The relative resource name identifying the VPC network that is using this configuration. For example: `projects/*/global/networks/network-1`. Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'. - "ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. + "ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 5 ports. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. 42, ], "routingMode": "A String", # Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY. diff --git a/docs/dyn/networkservices_v1.projects.locations.wasmPlugins.html b/docs/dyn/networkservices_v1.projects.locations.wasmPlugins.html index 56498957f09..e17b814c0ac 100644 --- a/docs/dyn/networkservices_v1.projects.locations.wasmPlugins.html +++ b/docs/dyn/networkservices_v1.projects.locations.wasmPlugins.html @@ -123,7 +123,7 @@Method Details
}, "logConfig": { # Specifies the logging options for the activity performed by this plugin. If logging is enabled, plugin logs are exported to Cloud Logging. # Optional. Specifies the logging options for the activity performed by this plugin. If logging is enabled, plugin logs are exported to Cloud Logging. Note that the settings relate to the logs generated by using logging statements in your Wasm code. "enable": True or False, # Optional. Specifies whether to enable logging for activity by this plugin. Defaults to `false`. - "minLogLevel": "A String", # Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default. + "minLogLevel": "A String", # Non-empty default. Specifies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default. "sampleRate": 3.14, # Non-empty default. Configures the sampling rate of activity logs, where `1.0` means all logged activity is reported and `0.0` means no activity is reported. A floating point value between `0.0` and `1.0` indicates that a percentage of log messages is stored. The default value when logging is enabled is `1.0`. The value of the field must be between `0` and `1` (inclusive). This field can be specified only if logging is enabled for this plugin. }, "mainVersionId": "A String", # Optional. The ID of the `WasmPluginVersion` resource that is the currently serving one. The version referred to must be a child of this `WasmPlugin` resource. @@ -243,7 +243,7 @@Method Details
}, "logConfig": { # Specifies the logging options for the activity performed by this plugin. If logging is enabled, plugin logs are exported to Cloud Logging. # Optional. Specifies the logging options for the activity performed by this plugin. If logging is enabled, plugin logs are exported to Cloud Logging. Note that the settings relate to the logs generated by using logging statements in your Wasm code. "enable": True or False, # Optional. Specifies whether to enable logging for activity by this plugin. Defaults to `false`. - "minLogLevel": "A String", # Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default. + "minLogLevel": "A String", # Non-empty default. Specifies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default. "sampleRate": 3.14, # Non-empty default. Configures the sampling rate of activity logs, where `1.0` means all logged activity is reported and `0.0` means no activity is reported. A floating point value between `0.0` and `1.0` indicates that a percentage of log messages is stored. The default value when logging is enabled is `1.0`. The value of the field must be between `0` and `1` (inclusive). This field can be specified only if logging is enabled for this plugin. }, "mainVersionId": "A String", # Optional. The ID of the `WasmPluginVersion` resource that is the currently serving one. The version referred to must be a child of this `WasmPlugin` resource. @@ -302,7 +302,7 @@Method Details
}, "logConfig": { # Specifies the logging options for the activity performed by this plugin. If logging is enabled, plugin logs are exported to Cloud Logging. # Optional. Specifies the logging options for the activity performed by this plugin. If logging is enabled, plugin logs are exported to Cloud Logging. Note that the settings relate to the logs generated by using logging statements in your Wasm code. "enable": True or False, # Optional. Specifies whether to enable logging for activity by this plugin. Defaults to `false`. - "minLogLevel": "A String", # Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default. + "minLogLevel": "A String", # Non-empty default. Specifies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default. "sampleRate": 3.14, # Non-empty default. Configures the sampling rate of activity logs, where `1.0` means all logged activity is reported and `0.0` means no activity is reported. A floating point value between `0.0` and `1.0` indicates that a percentage of log messages is stored. The default value when logging is enabled is `1.0`. The value of the field must be between `0` and `1` (inclusive). This field can be specified only if logging is enabled for this plugin. }, "mainVersionId": "A String", # Optional. The ID of the `WasmPluginVersion` resource that is the currently serving one. The version referred to must be a child of this `WasmPlugin` resource. @@ -364,7 +364,7 @@Method Details
}, "logConfig": { # Specifies the logging options for the activity performed by this plugin. If logging is enabled, plugin logs are exported to Cloud Logging. # Optional. Specifies the logging options for the activity performed by this plugin. If logging is enabled, plugin logs are exported to Cloud Logging. Note that the settings relate to the logs generated by using logging statements in your Wasm code. "enable": True or False, # Optional. Specifies whether to enable logging for activity by this plugin. Defaults to `false`. - "minLogLevel": "A String", # Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default. + "minLogLevel": "A String", # Non-empty default. Specifies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default. "sampleRate": 3.14, # Non-empty default. Configures the sampling rate of activity logs, where `1.0` means all logged activity is reported and `0.0` means no activity is reported. A floating point value between `0.0` and `1.0` indicates that a percentage of log messages is stored. The default value when logging is enabled is `1.0`. The value of the field must be between `0` and `1` (inclusive). This field can be specified only if logging is enabled for this plugin. }, "mainVersionId": "A String", # Optional. The ID of the `WasmPluginVersion` resource that is the currently serving one. The version referred to must be a child of this `WasmPlugin` resource. diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.gateways.html b/docs/dyn/networkservices_v1beta1.projects.locations.gateways.html index 0c650339db3..938f300f8f9 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.gateways.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.gateways.html @@ -132,7 +132,7 @@Method Details
}, "name": "A String", # Identifier. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`. "network": "A String", # Optional. The relative resource name identifying the VPC network that is using this configuration. For example: `projects/*/global/networks/network-1`. Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'. - "ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. + "ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 5 ports. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. 42, ], "routingMode": "A String", # Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY. @@ -240,7 +240,7 @@Method Details
}, "name": "A String", # Identifier. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`. "network": "A String", # Optional. The relative resource name identifying the VPC network that is using this configuration. For example: `projects/*/global/networks/network-1`. Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'. - "ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. + "ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 5 ports. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. 42, ], "routingMode": "A String", # Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY. @@ -288,7 +288,7 @@Method Details
}, "name": "A String", # Identifier. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`. "network": "A String", # Optional. The relative resource name identifying the VPC network that is using this configuration. For example: `projects/*/global/networks/network-1`. Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'. - "ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. + "ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 5 ports. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. 42, ], "routingMode": "A String", # Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY. @@ -347,7 +347,7 @@Method Details
}, "name": "A String", # Identifier. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`. "network": "A String", # Optional. The relative resource name identifying the VPC network that is using this configuration. For example: `projects/*/global/networks/network-1`. Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'. - "ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. + "ports": [ # Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 5 ports. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. 42, ], "routingMode": "A String", # Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY. diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.wasmPlugins.html b/docs/dyn/networkservices_v1beta1.projects.locations.wasmPlugins.html index ad28e575c19..85e150ccce7 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.wasmPlugins.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.wasmPlugins.html @@ -123,7 +123,7 @@Method Details
}, "logConfig": { # Specifies the logging options for the activity performed by this plugin. If logging is enabled, plugin logs are exported to Cloud Logging. # Optional. Specifies the logging options for the activity performed by this plugin. If logging is enabled, plugin logs are exported to Cloud Logging. Note that the settings relate to the logs generated by using logging statements in your Wasm code. "enable": True or False, # Optional. Specifies whether to enable logging for activity by this plugin. Defaults to `false`. - "minLogLevel": "A String", # Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default. + "minLogLevel": "A String", # Non-empty default. Specifies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default. "sampleRate": 3.14, # Non-empty default. Configures the sampling rate of activity logs, where `1.0` means all logged activity is reported and `0.0` means no activity is reported. A floating point value between `0.0` and `1.0` indicates that a percentage of log messages is stored. The default value when logging is enabled is `1.0`. The value of the field must be between `0` and `1` (inclusive). This field can be specified only if logging is enabled for this plugin. }, "mainVersionId": "A String", # Optional. The ID of the `WasmPluginVersion` resource that is the currently serving one. The version referred to must be a child of this `WasmPlugin` resource. @@ -243,7 +243,7 @@Method Details
}, "logConfig": { # Specifies the logging options for the activity performed by this plugin. If logging is enabled, plugin logs are exported to Cloud Logging. # Optional. Specifies the logging options for the activity performed by this plugin. If logging is enabled, plugin logs are exported to Cloud Logging. Note that the settings relate to the logs generated by using logging statements in your Wasm code. "enable": True or False, # Optional. Specifies whether to enable logging for activity by this plugin. Defaults to `false`. - "minLogLevel": "A String", # Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default. + "minLogLevel": "A String", # Non-empty default. Specifies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default. "sampleRate": 3.14, # Non-empty default. Configures the sampling rate of activity logs, where `1.0` means all logged activity is reported and `0.0` means no activity is reported. A floating point value between `0.0` and `1.0` indicates that a percentage of log messages is stored. The default value when logging is enabled is `1.0`. The value of the field must be between `0` and `1` (inclusive). This field can be specified only if logging is enabled for this plugin. }, "mainVersionId": "A String", # Optional. The ID of the `WasmPluginVersion` resource that is the currently serving one. The version referred to must be a child of this `WasmPlugin` resource. @@ -302,7 +302,7 @@Method Details
}, "logConfig": { # Specifies the logging options for the activity performed by this plugin. If logging is enabled, plugin logs are exported to Cloud Logging. # Optional. Specifies the logging options for the activity performed by this plugin. If logging is enabled, plugin logs are exported to Cloud Logging. Note that the settings relate to the logs generated by using logging statements in your Wasm code. "enable": True or False, # Optional. Specifies whether to enable logging for activity by this plugin. Defaults to `false`. - "minLogLevel": "A String", # Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default. + "minLogLevel": "A String", # Non-empty default. Specifies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default. "sampleRate": 3.14, # Non-empty default. Configures the sampling rate of activity logs, where `1.0` means all logged activity is reported and `0.0` means no activity is reported. A floating point value between `0.0` and `1.0` indicates that a percentage of log messages is stored. The default value when logging is enabled is `1.0`. The value of the field must be between `0` and `1` (inclusive). This field can be specified only if logging is enabled for this plugin. }, "mainVersionId": "A String", # Optional. The ID of the `WasmPluginVersion` resource that is the currently serving one. The version referred to must be a child of this `WasmPlugin` resource. @@ -364,7 +364,7 @@Method Details
}, "logConfig": { # Specifies the logging options for the activity performed by this plugin. If logging is enabled, plugin logs are exported to Cloud Logging. # Optional. Specifies the logging options for the activity performed by this plugin. If logging is enabled, plugin logs are exported to Cloud Logging. Note that the settings relate to the logs generated by using logging statements in your Wasm code. "enable": True or False, # Optional. Specifies whether to enable logging for activity by this plugin. Defaults to `false`. - "minLogLevel": "A String", # Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default. + "minLogLevel": "A String", # Non-empty default. Specifies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default. "sampleRate": 3.14, # Non-empty default. Configures the sampling rate of activity logs, where `1.0` means all logged activity is reported and `0.0` means no activity is reported. A floating point value between `0.0` and `1.0` indicates that a percentage of log messages is stored. The default value when logging is enabled is `1.0`. The value of the field must be between `0` and `1` (inclusive). This field can be specified only if logging is enabled for this plugin. }, "mainVersionId": "A String", # Optional. The ID of the `WasmPluginVersion` resource that is the currently serving one. The version referred to must be a child of this `WasmPlugin` resource. diff --git a/docs/dyn/notebooks_v2.projects.locations.instances.html b/docs/dyn/notebooks_v2.projects.locations.instances.html index b3c534c38d0..42dd5125eba 100644 --- a/docs/dyn/notebooks_v2.projects.locations.instances.html +++ b/docs/dyn/notebooks_v2.projects.locations.instances.html @@ -74,6 +74,9 @@Notebooks API . projects . locations . instances
Instance Methods
++
+checkAuthorization(name, body=None, x__xgafv=None)Initiated by Cloud Console for Oauth consent flow for Workbench Instances. Do not use this method directly. Design doc: go/wbi-euc:auth-dd
checkUpgradability(notebookInstance, x__xgafv=None)Checks whether a notebook instance is upgradable.
@@ -89,6 +92,9 @@Instance Methods
diagnose(name, body=None, x__xgafv=None)Creates a Diagnostic File and runs Diagnostic Tool given an Instance.
++
+generateAccessToken(name, body=None, x__xgafv=None)Called by VM to return an EUC for the instance owner. Do not use this method directly. Design doc: go/wbi-euc:dd
Gets details of a single Instance.
@@ -141,6 +147,36 @@Instance Methods
upgradeSystem(name, body=None, x__xgafv=None)Allows notebook instances to upgrade themselves. Do not use this method directly.
Method Details
+++checkAuthorization(name, body=None, x__xgafv=None)+Initiated by Cloud Console for Oauth consent flow for Workbench Instances. Do not use this method directly. Design doc: go/wbi-euc:auth-dd + +Args: + name: string, Required. The name of the Notebook Instance resource. Format: `projects/{project}/locations/{location}/instances/{instance}` (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for checking authorization for the instance owner. + "authorizationDetails": { # Optional. The details of the OAuth authorization response. This may include additional params such as dry_run, version_info, origin, propagate, etc. + "a_key": "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 checking authorization for the instance owner. + "createTime": "A String", # Output only. Timestamp when this Authorization request was created. + "oauth_uri": "A String", # If the user has not completed OAuth consent, then the oauth_url is returned. Otherwise, this field is not set. + "success": True or False, # Success indicates that the user completed OAuth consent and access tokens can be generated. +}++checkUpgradability(notebookInstance, x__xgafv=None)Checks whether a notebook instance is upgradable. @@ -182,6 +218,7 @@Method Details
"creator": "A String", # Output only. Email address of entity that sent original CreateInstance request. "disableProxyAccess": True or False, # Optional. If true, the notebook instance will not register with the proxy. "enableDeletionProtection": True or False, # Optional. If true, deletion protection will be enabled for this Workbench Instance. If false, deletion protection will be disabled for this Workbench Instance. + "enableManagedEuc": True or False, # Optional. Flag to enable managed end user credentials for the instance. "enableThirdPartyIdentity": True or False, # Optional. Flag that specifies that a notebook can be accessed with third party identity provider. "gceSetup": { # The definition of how to configure a VM instance outside of Resources and Identity. # Optional. Compute Engine setup for the notebook. Uses notebook-defined fields. "acceleratorConfigs": [ # Optional. The hardware accelerators used on this instance. If you use accelerators, make sure that your configuration has [enough vCPUs and memory to support the `machine_type` you have selected](https://cloud.google.com/compute/docs/gpus/#gpus-list). Currently supports only one accelerator configuration. @@ -412,6 +449,35 @@Method Details
}++generateAccessToken(name, body=None, x__xgafv=None)+Called by VM to return an EUC for the instance owner. Do not use this method directly. Design doc: go/wbi-euc:dd + +Args: + name: string, Required. Format: `projects/{project}/locations/{location}/instances/{instance_id}` (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for generating an EUC for the instance owner. + "vmToken": "A String", # Required. The VM identity token (a JWT) for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity +} + + 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 generating an EUC for the instance owner. + "access_token": "A String", # Short-lived access token string which may be used to access Google APIs. + "expires_in": 42, # The time in seconds when the access token expires. Typically that's 3600. + "scope": "A String", # Space-separated list of scopes contained in the returned token. https://cloud.google.com/docs/authentication/token-types#access-contents + "token_type": "A String", # Type of the returned access token (e.g. "Bearer"). It specifies how the token must be used. Bearer tokens may be used by any entity without proof of identity. +}+get(name, x__xgafv=None)Gets details of a single Instance. @@ -431,6 +497,7 @@Method Details
"creator": "A String", # Output only. Email address of entity that sent original CreateInstance request. "disableProxyAccess": True or False, # Optional. If true, the notebook instance will not register with the proxy. "enableDeletionProtection": True or False, # Optional. If true, deletion protection will be enabled for this Workbench Instance. If false, deletion protection will be disabled for this Workbench Instance. + "enableManagedEuc": True or False, # Optional. Flag to enable managed end user credentials for the instance. "enableThirdPartyIdentity": True or False, # Optional. Flag that specifies that a notebook can be accessed with third party identity provider. "gceSetup": { # The definition of how to configure a VM instance outside of Resources and Identity. # Optional. Compute Engine setup for the notebook. Uses notebook-defined fields. "acceleratorConfigs": [ # Optional. The hardware accelerators used on this instance. If you use accelerators, make sure that your configuration has [enough vCPUs and memory to support the `machine_type` you have selected](https://cloud.google.com/compute/docs/gpus/#gpus-list). Currently supports only one accelerator configuration. @@ -642,6 +709,7 @@Method Details
"creator": "A String", # Output only. Email address of entity that sent original CreateInstance request. "disableProxyAccess": True or False, # Optional. If true, the notebook instance will not register with the proxy. "enableDeletionProtection": True or False, # Optional. If true, deletion protection will be enabled for this Workbench Instance. If false, deletion protection will be disabled for this Workbench Instance. + "enableManagedEuc": True or False, # Optional. Flag to enable managed end user credentials for the instance. "enableThirdPartyIdentity": True or False, # Optional. Flag that specifies that a notebook can be accessed with third party identity provider. "gceSetup": { # The definition of how to configure a VM instance outside of Resources and Identity. # Optional. Compute Engine setup for the notebook. Uses notebook-defined fields. "acceleratorConfigs": [ # Optional. The hardware accelerators used on this instance. If you use accelerators, make sure that your configuration has [enough vCPUs and memory to support the `machine_type` you have selected](https://cloud.google.com/compute/docs/gpus/#gpus-list). Currently supports only one accelerator configuration. @@ -791,6 +859,7 @@Method Details
"creator": "A String", # Output only. Email address of entity that sent original CreateInstance request. "disableProxyAccess": True or False, # Optional. If true, the notebook instance will not register with the proxy. "enableDeletionProtection": True or False, # Optional. If true, deletion protection will be enabled for this Workbench Instance. If false, deletion protection will be disabled for this Workbench Instance. + "enableManagedEuc": True or False, # Optional. Flag to enable managed end user credentials for the instance. "enableThirdPartyIdentity": True or False, # Optional. Flag that specifies that a notebook can be accessed with third party identity provider. "gceSetup": { # The definition of how to configure a VM instance outside of Resources and Identity. # Optional. Compute Engine setup for the notebook. Uses notebook-defined fields. "acceleratorConfigs": [ # Optional. The hardware accelerators used on this instance. If you use accelerators, make sure that your configuration has [enough vCPUs and memory to support the `machine_type` you have selected](https://cloud.google.com/compute/docs/gpus/#gpus-list). Currently supports only one accelerator configuration. diff --git a/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html b/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html index e5153ed73c8..031d40e9eb2 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html @@ -140,6 +140,8 @@Method Details
}, "name": "A String", # Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database} "network": "A String", # Optional. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network} + "odbNetwork": "A String", # Optional. The name of the OdbNetwork associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet. + "odbSubnet": "A String", # Optional. The name of the OdbSubnet associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} "peerAutonomousDatabases": [ # Output only. The peer Autonomous Database names of the given Autonomous Database. "A String", ], @@ -404,6 +406,8 @@Method Details
}, "name": "A String", # Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database} "network": "A String", # Optional. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network} + "odbNetwork": "A String", # Optional. The name of the OdbNetwork associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet. + "odbSubnet": "A String", # Optional. The name of the OdbSubnet associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} "peerAutonomousDatabases": [ # Output only. The peer Autonomous Database names of the given Autonomous Database. "A String", ], @@ -580,6 +584,8 @@Method Details
}, "name": "A String", # Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database} "network": "A String", # Optional. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network} + "odbNetwork": "A String", # Optional. The name of the OdbNetwork associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet. + "odbSubnet": "A String", # Optional. The name of the OdbSubnet associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} "peerAutonomousDatabases": [ # Output only. The peer Autonomous Database names of the given Autonomous Database. "A String", ], diff --git a/docs/dyn/oracledatabase_v1.projects.locations.cloudVmClusters.dbNodes.html b/docs/dyn/oracledatabase_v1.projects.locations.cloudVmClusters.dbNodes.html index c6b230634d3..345e4180e66 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.cloudVmClusters.dbNodes.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.cloudVmClusters.dbNodes.html @@ -110,6 +110,7 @@Method Details
{ # Details of the database node resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbNode/ "name": "A String", # Identifier. The name of the database node resource in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node} "properties": { # Various properties and settings associated with Db node. # Optional. Various properties of the database node. + "createTime": "A String", # Output only. The date and time that the database node was created. "dbNodeStorageSizeGb": 42, # Optional. Local storage per database node. "dbServerOcid": "A String", # Optional. Database server OCID. "hostname": "A String", # Optional. DNS diff --git a/docs/dyn/oracledatabase_v1.projects.locations.cloudVmClusters.html b/docs/dyn/oracledatabase_v1.projects.locations.cloudVmClusters.html index e1e2522446a..ddca52aae7a 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.cloudVmClusters.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.cloudVmClusters.html @@ -113,6 +113,7 @@Method Details
The object takes the form of: { # Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/ + "backupOdbSubnet": "A String", # Optional. The name of the backup OdbSubnet associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} "backupSubnetCidr": "A String", # Optional. CIDR range of the backup subnet. "cidr": "A String", # Optional. Network settings. CIDR to use for cluster IP allocation. "createTime": "A String", # Output only. The date and time that the VM cluster was created. @@ -124,6 +125,8 @@Method Details
}, "name": "A String", # Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster} "network": "A String", # Optional. The name of the VPC network. Format: projects/{project}/global/networks/{network} + "odbNetwork": "A String", # Optional. The name of the OdbNetwork associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the odb_subnet and backup_odb_subnet. + "odbSubnet": "A String", # Optional. The name of the OdbSubnet associated with the VM Cluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} "properties": { # Various properties and settings associated with Exadata VM cluster. # Optional. Various properties of the VM Cluster. "clusterName": "A String", # Optional. OCI Cluster name. "compartmentId": "A String", # Output only. Compartment ID of cluster. @@ -257,6 +260,7 @@Method Details
An object of the form: { # Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/ + "backupOdbSubnet": "A String", # Optional. The name of the backup OdbSubnet associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} "backupSubnetCidr": "A String", # Optional. CIDR range of the backup subnet. "cidr": "A String", # Optional. Network settings. CIDR to use for cluster IP allocation. "createTime": "A String", # Output only. The date and time that the VM cluster was created. @@ -268,6 +272,8 @@Method Details
}, "name": "A String", # Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster} "network": "A String", # Optional. The name of the VPC network. Format: projects/{project}/global/networks/{network} + "odbNetwork": "A String", # Optional. The name of the OdbNetwork associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the odb_subnet and backup_odb_subnet. + "odbSubnet": "A String", # Optional. The name of the OdbSubnet associated with the VM Cluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} "properties": { # Various properties and settings associated with Exadata VM cluster. # Optional. Various properties of the VM Cluster. "clusterName": "A String", # Optional. OCI Cluster name. "compartmentId": "A String", # Output only. Compartment ID of cluster. @@ -339,6 +345,7 @@Method Details
{ # The response for `CloudVmCluster.List`. "cloudVmClusters": [ # The list of VM Clusters. { # Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/ + "backupOdbSubnet": "A String", # Optional. The name of the backup OdbSubnet associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} "backupSubnetCidr": "A String", # Optional. CIDR range of the backup subnet. "cidr": "A String", # Optional. Network settings. CIDR to use for cluster IP allocation. "createTime": "A String", # Output only. The date and time that the VM cluster was created. @@ -350,6 +357,8 @@Method Details
}, "name": "A String", # Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster} "network": "A String", # Optional. The name of the VPC network. Format: projects/{project}/global/networks/{network} + "odbNetwork": "A String", # Optional. The name of the OdbNetwork associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the odb_subnet and backup_odb_subnet. + "odbSubnet": "A String", # Optional. The name of the OdbSubnet associated with the VM Cluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} "properties": { # Various properties and settings associated with Exadata VM cluster. # Optional. Various properties of the VM Cluster. "clusterName": "A String", # Optional. OCI Cluster name. "compartmentId": "A String", # Output only. Compartment ID of cluster. diff --git a/docs/dyn/oracledatabase_v1.projects.locations.html b/docs/dyn/oracledatabase_v1.projects.locations.html index e08fefad0ca..ebcf8533d9e 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.html @@ -119,6 +119,11 @@Instance Methods
Returns the giVersions Resource.
++
+odbNetworks()+Returns the odbNetworks Resource.
+ diff --git a/docs/dyn/oracledatabase_v1.projects.locations.odbNetworks.html b/docs/dyn/oracledatabase_v1.projects.locations.odbNetworks.html new file mode 100644 index 00000000000..a5ca601f7e4 --- /dev/null +++ b/docs/dyn/oracledatabase_v1.projects.locations.odbNetworks.html @@ -0,0 +1,271 @@ + + + +Oracle Database@Google Cloud API . projects . locations . odbNetworks
+Instance Methods
++
+odbSubnets()+Returns the odbSubnets Resource.
+ ++
+close()Close httplib2 connections.
++
+create(parent, body=None, odbNetworkId=None, requestId=None, x__xgafv=None)Creates a new ODB Network in a given project and location.
++
+delete(name, requestId=None, x__xgafv=None)Deletes a single ODB Network.
+ +Gets details of a single ODB Network.
++
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)Lists the ODB Networks in a given project and location.
+ +Retrieves the next page of results.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(parent, body=None, odbNetworkId=None, requestId=None, x__xgafv=None)+Creates a new ODB Network in a given project and location. + +Args: + parent: string, Required. The parent value for the OdbNetwork in the following format: projects/{project}/locations/{location}. (required) + body: object, The request body. + The object takes the form of: + +{ # Represents OdbNetwork resource. + "createTime": "A String", # Output only. The date and time that the OdbNetwork was created. + "entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the OdbNetwork. + "labels": { # Optional. Labels or tags associated with the resource. + "a_key": "A String", + }, + "name": "A String", # Identifier. The name of the OdbNetwork resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network} + "network": "A String", # Required. The name of the VPC network in the following format: projects/{project}/global/networks/{network} + "state": "A String", # Output only. State of the ODB Network. +} + + odbNetworkId: string, Required. The ID of the OdbNetwork to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + requestId: string, Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # This resource represents a long-running operation that is the result of a network API call. + "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, +}+++ +delete(name, requestId=None, x__xgafv=None)+Deletes a single ODB Network. + +Args: + name: string, Required. The name of the resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}. (required) + requestId: string, Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # This resource represents a long-running operation that is the result of a network API call. + "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, +}+++ +get(name, x__xgafv=None)+Gets details of a single ODB Network. + +Args: + name: string, Required. The name of the OdbNetwork in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents OdbNetwork resource. + "createTime": "A String", # Output only. The date and time that the OdbNetwork was created. + "entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the OdbNetwork. + "labels": { # Optional. Labels or tags associated with the resource. + "a_key": "A String", + }, + "name": "A String", # Identifier. The name of the OdbNetwork resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network} + "network": "A String", # Required. The name of the VPC network in the following format: projects/{project}/global/networks/{network} + "state": "A String", # Output only. State of the ODB Network. +}+++ +list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)+Lists the ODB Networks in a given project and location. + +Args: + parent: string, Required. The parent value for the ODB Network in the following format: projects/{project}/locations/{location}. (required) + filter: string, Optional. An expression for filtering the results of the request. + orderBy: string, Optional. An expression for ordering the results of the request. + pageSize: integer, Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + pageToken: string, Optional. A token identifying a page of results the server should return. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # The response for `OdbNetwork.List`. + "nextPageToken": "A String", # A token identifying a page of results the server should return. + "odbNetworks": [ # The list of ODB Networks. + { # Represents OdbNetwork resource. + "createTime": "A String", # Output only. The date and time that the OdbNetwork was created. + "entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the OdbNetwork. + "labels": { # Optional. Labels or tags associated with the resource. + "a_key": "A String", + }, + "name": "A String", # Identifier. The name of the OdbNetwork resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network} + "network": "A String", # Required. The name of the VPC network in the following format: projects/{project}/global/networks/{network} + "state": "A String", # Output only. State of the ODB Network. + }, + ], + "unreachable": [ # Unreachable locations when listing resources across all locations using wildcard location '-'. + "A String", + ], +}+++ + \ No newline at end of file diff --git a/docs/dyn/oracledatabase_v1.projects.locations.odbNetworks.odbSubnets.html b/docs/dyn/oracledatabase_v1.projects.locations.odbNetworks.odbSubnets.html new file mode 100644 index 00000000000..a53dc2da82f --- /dev/null +++ b/docs/dyn/oracledatabase_v1.projects.locations.odbNetworks.odbSubnets.html @@ -0,0 +1,266 @@ + + + +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. ++Oracle Database@Google Cloud API . projects . locations . odbNetworks . odbSubnets
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(parent, body=None, odbSubnetId=None, requestId=None, x__xgafv=None)Creates a new ODB Subnet in a given ODB Network.
++
+delete(name, requestId=None, x__xgafv=None)Deletes a single ODB Subnet.
+ +Gets details of a single ODB Subnet.
++
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)Lists all the ODB Subnets in a given ODB Network.
+ +Retrieves the next page of results.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(parent, body=None, odbSubnetId=None, requestId=None, x__xgafv=None)+Creates a new ODB Subnet in a given ODB Network. + +Args: + parent: string, Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}. (required) + body: object, The request body. + The object takes the form of: + +{ # Represents OdbSubnet resource. + "cidrRange": "A String", # Required. The CIDR range of the subnet. + "createTime": "A String", # Output only. The date and time that the OdbNetwork was created. + "labels": { # Optional. Labels or tags associated with the resource. + "a_key": "A String", + }, + "name": "A String", # Identifier. The name of the OdbSubnet resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} + "purpose": "A String", # Required. Purpose of the subnet. + "state": "A String", # Output only. State of the ODB Subnet. +} + + odbSubnetId: string, Required. The ID of the OdbSubnet to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + requestId: string, Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # This resource represents a long-running operation that is the result of a network API call. + "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, +}+++ +delete(name, requestId=None, x__xgafv=None)+Deletes a single ODB Subnet. + +Args: + name: string, Required. The name of the resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}. (required) + requestId: string, Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # This resource represents a long-running operation that is the result of a network API call. + "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, +}+++ +get(name, x__xgafv=None)+Gets details of a single ODB Subnet. + +Args: + name: string, Required. The name of the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents OdbSubnet resource. + "cidrRange": "A String", # Required. The CIDR range of the subnet. + "createTime": "A String", # Output only. The date and time that the OdbNetwork was created. + "labels": { # Optional. Labels or tags associated with the resource. + "a_key": "A String", + }, + "name": "A String", # Identifier. The name of the OdbSubnet resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} + "purpose": "A String", # Required. Purpose of the subnet. + "state": "A String", # Output only. State of the ODB Subnet. +}+++ +list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)+Lists all the ODB Subnets in a given ODB Network. + +Args: + parent: string, Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}. (required) + filter: string, Optional. An expression for filtering the results of the request. + orderBy: string, Optional. An expression for ordering the results of the request. + pageSize: integer, Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + pageToken: string, Optional. A token identifying a page of results the server should return. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # The response for `OdbSubnet.List`. + "nextPageToken": "A String", # A token identifying a page of results the server should return. + "odbSubnets": [ # The list of ODB Subnets. + { # Represents OdbSubnet resource. + "cidrRange": "A String", # Required. The CIDR range of the subnet. + "createTime": "A String", # Output only. The date and time that the OdbNetwork was created. + "labels": { # Optional. Labels or tags associated with the resource. + "a_key": "A String", + }, + "name": "A String", # Identifier. The name of the OdbSubnet resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet} + "purpose": "A String", # Required. Purpose of the subnet. + "state": "A String", # Output only. State of the ODB Subnet. + }, + ], + "unreachable": [ # Unreachable locations when listing resources across all locations using wildcard location '-'. + "A String", + ], +}+++ + \ No newline at end of file diff --git a/docs/dyn/paymentsresellersubscription_v1.partners.userSessions.html b/docs/dyn/paymentsresellersubscription_v1.partners.userSessions.html index c412e543760..07c9512ea63 100644 --- a/docs/dyn/paymentsresellersubscription_v1.partners.userSessions.html +++ b/docs/dyn/paymentsresellersubscription_v1.partners.userSessions.html @@ -95,7 +95,7 @@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. ++Method Details
body: object, The request body. The object takes the form of: -{ # [Preview only] Request to generate a user session. +{ # Request to generate a user session. "intentPayload": { # The payload that describes the user intent. # The user intent to generate the user session. "createIntent": { # Intent message for creating a Subscription resource. # The request to create a subscription. "parent": "A String", # Required. The parent resource name, which is the identifier of the partner. @@ -247,7 +247,7 @@Method Details
Returns: An object of the form: - { # [Preview only] Response that contains the details for generated user session. + { # Response that contains the details for generated user session. "userSession": { # A user session contains a short-lived token that includes information required to interact with Google Payments Reseller Platform using the following web endpoints. - A user session token should be generated dynamically for an authenticated user. You should refrain from sharing a token directly with a user in an unauthenticated context, such as SMS, or email. - You can re-generate new session tokens repeatedly for same `generate` request if necessary, regardless of the previous tokens being expired or not. You don't need to worry about multiple sessions resulting in duplicate fulfillments as guaranteed by the same subscription id. Please refer to the [Google Managed Signup](/payments/reseller/subscription/reference/index/User.Signup.Integration/Google.Managed.Signup) documentation for additional integration details. # The generated user session. The token size is proportional to the size of the intent payload. "expireTime": "A String", # Output only. The time at which the user session expires. "token": "A String", # Output only. The encrypted token of the user session, including the information of the user's intent and request. This token should be provided when redirecting the user to Google. diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.html index 3a1d57f92b3..a04567dd889 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.html @@ -575,7 +575,6 @@Method Details
"feeds": [ # Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds. { # Merchant Center Feed filter criterion. "dataSourceId": "A String", # AFM data source ID. - "primaryFeedId": "A String", # Merchant Center primary feed ID. Deprecated: use data_source_id instead. "primaryFeedName": "A String", # Merchant Center primary feed name. The name is used for the display purposes only. }, ], @@ -631,7 +630,6 @@Method Details
"feeds": [ # Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds. { # Merchant Center Feed filter criterion. "dataSourceId": "A String", # AFM data source ID. - "primaryFeedId": "A String", # Merchant Center primary feed ID. Deprecated: use data_source_id instead. "primaryFeedName": "A String", # Merchant Center primary feed name. The name is used for the display purposes only. }, ], @@ -669,7 +667,6 @@Method Details
"feeds": [ # Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds. { # Merchant Center Feed filter criterion. "dataSourceId": "A String", # AFM data source ID. - "primaryFeedId": "A String", # Merchant Center primary feed ID. Deprecated: use data_source_id instead. "primaryFeedName": "A String", # Merchant Center primary feed name. The name is used for the display purposes only. }, ], diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.html index a808246b87c..3186873495d 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.html @@ -549,7 +549,6 @@Method Details
"feeds": [ # Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds. { # Merchant Center Feed filter criterion. "dataSourceId": "A String", # AFM data source ID. - "primaryFeedId": "A String", # Merchant Center primary feed ID. Deprecated: use data_source_id instead. "primaryFeedName": "A String", # Merchant Center primary feed name. The name is used for the display purposes only. }, ], @@ -605,7 +604,6 @@Method Details
"feeds": [ # Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds. { # Merchant Center Feed filter criterion. "dataSourceId": "A String", # AFM data source ID. - "primaryFeedId": "A String", # Merchant Center primary feed ID. Deprecated: use data_source_id instead. "primaryFeedName": "A String", # Merchant Center primary feed name. The name is used for the display purposes only. }, ], @@ -643,7 +641,6 @@Method Details
"feeds": [ # Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds. { # Merchant Center Feed filter criterion. "dataSourceId": "A String", # AFM data source ID. - "primaryFeedId": "A String", # Merchant Center primary feed ID. Deprecated: use data_source_id instead. "primaryFeedName": "A String", # Merchant Center primary feed name. The name is used for the display purposes only. }, ], diff --git a/docs/dyn/run_v2.projects.locations.workerPools.html b/docs/dyn/run_v2.projects.locations.workerPools.html index b51d33e0cce..f6c38a59d19 100644 --- a/docs/dyn/run_v2.projects.locations.workerPools.html +++ b/docs/dyn/run_v2.projects.locations.workerPools.html @@ -120,7 +120,7 @@Method Details
Creates a new WorkerPool in a given project and location. Args: - parent: string, Required. The location and project in which this worker pool should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number. Only lowercase characters, digits, and hyphens. (required) + parent: string, Required. The location and project in which this worker pool should be created. Format: `projects/{project}/locations/{location}`, where `{project}` can be project id or number. Only lowercase characters, digits, and hyphens. (required) body: object, The request body. The object takes the form of: @@ -178,7 +178,7 @@Method Details
"latestCreatedRevision": "A String", # Output only. Name of the last created revision. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "latestReadyRevision": "A String", # Output only. Name of the latest revision that is serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "launchStage": "A String", # Optional. The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. - "name": "A String", # The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project}/locations/{location}/workerPools/{worker_id} + "name": "A String", # The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: `projects/{project}/locations/{location}/workerPools/{worker_id}` "observedGeneration": "A String", # Output only. The generation of this WorkerPool currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. "reconciling": True or False, # Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state. When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in `terminal_condition` and `conditions`. "satisfiesPzs": True or False, # Output only. Reserved for future use. @@ -290,6 +290,7 @@Method Details
"encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek "encryptionKeyRevocationAction": "A String", # Optional. The action to take if the encryption key is revoked. "encryptionKeyShutdownDuration": "A String", # Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour. + "gpuZonalRedundancyDisabled": True or False, # Optional. True if GPU zonal redundancy is disabled on this worker pool. "labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate. "a_key": "A String", }, @@ -367,7 +368,7 @@Method Details
} validateOnly: boolean, Optional. Indicates that the request should be validated and default values populated, without persisting the request or creating any resources. - workerPoolId: string, Required. The unique identifier for the WorkerPool. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the worker pool becomes {parent}/workerPools/{worker_pool_id}. + workerPoolId: string, Required. The unique identifier for the WorkerPool. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the worker pool becomes `{parent}/workerPools/{worker_pool_id}`. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -402,7 +403,7 @@Method Details
Deletes a WorkerPool. Args: - name: string, Required. The full name of the WorkerPool. Format: projects/{project}/locations/{location}/workerPools/{worker_pool}, where {project} can be project id or number. (required) + name: string, Required. The full name of the WorkerPool. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`, where `{project}` can be project id or number. (required) etag: string, A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. validateOnly: boolean, Optional. Indicates that the request should be validated without actually deleting any resources. x__xgafv: string, V1 error format. @@ -439,7 +440,7 @@Method Details
Gets information about a WorkerPool. Args: - name: string, Required. The full name of the WorkerPool. Format: projects/{project}/locations/{location}/workerPools/{worker_pool}, where {project} can be project id or number. (required) + name: string, Required. The full name of the WorkerPool. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`, where `{project}` can be project id or number. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -502,7 +503,7 @@Method Details
"latestCreatedRevision": "A String", # Output only. Name of the last created revision. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "latestReadyRevision": "A String", # Output only. Name of the latest revision that is serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "launchStage": "A String", # Optional. The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. - "name": "A String", # The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project}/locations/{location}/workerPools/{worker_id} + "name": "A String", # The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: `projects/{project}/locations/{location}/workerPools/{worker_id}` "observedGeneration": "A String", # Output only. The generation of this WorkerPool currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. "reconciling": True or False, # Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state. When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in `terminal_condition` and `conditions`. "satisfiesPzs": True or False, # Output only. Reserved for future use. @@ -614,6 +615,7 @@Method Details
"encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek "encryptionKeyRevocationAction": "A String", # Optional. The action to take if the encryption key is revoked. "encryptionKeyShutdownDuration": "A String", # Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour. + "gpuZonalRedundancyDisabled": True or False, # Optional. True if GPU zonal redundancy is disabled on this worker pool. "labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate. "a_key": "A String", }, @@ -744,7 +746,7 @@Method Details
Lists WorkerPools. Results are sorted by creation time, descending. Args: - parent: string, Required. The location and project to list resources on. Location must be a valid Google Cloud region, and cannot be the "-" wildcard. Format: projects/{project}/locations/{location}, where {project} can be project id or number. (required) + parent: string, Required. The location and project to list resources on. Location must be a valid Google Cloud region, and cannot be the "-" wildcard. Format: `projects/{project}/locations/{location}`, where `{project}` can be project id or number. (required) pageSize: integer, Maximum number of WorkerPools to return in this call. pageToken: string, A page token received from a previous call to ListWorkerPools. All other parameters must match. showDeleted: boolean, If true, returns deleted (but unexpired) resources along with active ones. @@ -813,7 +815,7 @@Method Details
"latestCreatedRevision": "A String", # Output only. Name of the last created revision. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "latestReadyRevision": "A String", # Output only. Name of the latest revision that is serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "launchStage": "A String", # Optional. The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. - "name": "A String", # The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project}/locations/{location}/workerPools/{worker_id} + "name": "A String", # The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: `projects/{project}/locations/{location}/workerPools/{worker_id}` "observedGeneration": "A String", # Output only. The generation of this WorkerPool currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. "reconciling": True or False, # Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state. When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in `terminal_condition` and `conditions`. "satisfiesPzs": True or False, # Output only. Reserved for future use. @@ -925,6 +927,7 @@Method Details
"encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek "encryptionKeyRevocationAction": "A String", # Optional. The action to take if the encryption key is revoked. "encryptionKeyShutdownDuration": "A String", # Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour. + "gpuZonalRedundancyDisabled": True or False, # Optional. True if GPU zonal redundancy is disabled on this worker pool. "labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate. "a_key": "A String", }, @@ -1023,7 +1026,7 @@Method Details
Updates a WorkerPool. Args: - name: string, The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project}/locations/{location}/workerPools/{worker_id} (required) + name: string, The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: `projects/{project}/locations/{location}/workerPools/{worker_id}` (required) body: object, The request body. The object takes the form of: @@ -1081,7 +1084,7 @@Method Details
"latestCreatedRevision": "A String", # Output only. Name of the last created revision. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "latestReadyRevision": "A String", # Output only. Name of the latest revision that is serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "launchStage": "A String", # Optional. The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. - "name": "A String", # The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project}/locations/{location}/workerPools/{worker_id} + "name": "A String", # The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: `projects/{project}/locations/{location}/workerPools/{worker_id}` "observedGeneration": "A String", # Output only. The generation of this WorkerPool currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. "reconciling": True or False, # Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state. When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in `terminal_condition` and `conditions`. "satisfiesPzs": True or False, # Output only. Reserved for future use. @@ -1193,6 +1196,7 @@Method Details
"encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek "encryptionKeyRevocationAction": "A String", # Optional. The action to take if the encryption key is revoked. "encryptionKeyShutdownDuration": "A String", # Optional. If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour. + "gpuZonalRedundancyDisabled": True or False, # Optional. True if GPU zonal redundancy is disabled on this worker pool. "labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate. "a_key": "A String", }, diff --git a/docs/dyn/searchconsole_v1.searchanalytics.html b/docs/dyn/searchconsole_v1.searchanalytics.html index 8ad967c5722..49b6ac30df4 100644 --- a/docs/dyn/searchconsole_v1.searchanalytics.html +++ b/docs/dyn/searchconsole_v1.searchanalytics.html @@ -130,9 +130,9 @@Method Details
An object of the form: { # A list of rows, one per result, grouped by key. Metrics in each row are aggregated for all data grouped by that key either by page or property, as specified by the aggregation type parameter. - "metadata": { - "firstIncompleteDate": "A String", - "firstIncompleteHour": "A String", + "metadata": { # An object that may be returned with your query results, providing context about the state of the data. When you request recent data (using `all` or `hourly_all` for `dataState`), some of the rows returned may represent data that is incomplete, which means that the data is still being collected and processed. This metadata object helps you identify exactly when this starts and ends. All dates and times provided in this object are in the `America/Los_Angeles` time zone. The specific field returned within this object depends on how you've grouped your data in the request. See details in inner fields. # An object that may be returned with your query results, providing context about the state of the data. See details in Metadata object documentation. + "firstIncompleteDate": "A String", # The first date for which the data is still being collected and processed, presented in `YYYY-MM-DD` format (ISO-8601 extended local date format). This field is populated only when the request's `dataState` is "`all`", data is grouped by "`DATE`", and the requested date range contains incomplete data points. All values after the `first_incomplete_date` may still change noticeably. + "firstIncompleteHour": "A String", # The first hour for which the data is still being collected and processed, presented in `YYYY-MM-DDThh:mm:ss[+|-]hh:mm` format (ISO-8601 extended offset date-time format). This field is populated only when the request's `dataState` is "`hourly_all`", data is grouped by "`HOUR`" and the requested date range contains incomplete data points. All values after the `first_incomplete_hour` may still change noticeably. }, "responseAggregationType": "A String", # How the results were aggregated. "rows": [ # A list of rows grouped by the key values in the order given in the query. diff --git a/docs/dyn/servicenetworking_v1.services.html b/docs/dyn/servicenetworking_v1.services.html index 504e390d02d..4257dbf9c85 100644 --- a/docs/dyn/servicenetworking_v1.services.html +++ b/docs/dyn/servicenetworking_v1.services.html @@ -337,7 +337,7 @@Method Details
"consumerProject": { # Represents a consumer project. # NETWORK_NOT_IN_CONSUMERS_PROJECT, NETWORK_NOT_IN_CONSUMERS_HOST_PROJECT, and HOST_PROJECT_NOT_FOUND are done when consumer_project is provided. "projectNum": "A String", # Required. Project number of the consumer that is launching the service instance. It can own the network that is peered with Google or, be a service project in an XPN where the host project has the network. }, - "rangeReservation": { # Represents a range reservation. # RANGES_EXHAUSTED, RANGES_EXHAUSTED, and RANGES_DELETED_LATER are done when range_reservation is provided. + "rangeReservation": { # Represents a range reservation. # RANGES_EXHAUSTED, RANGES_NOT_RESERVED, and RANGES_DELETED_LATER are done when range_reservation is provided. "ipPrefixLength": 42, # Required. The size of the desired subnet. Use usual CIDR range notation. For example, '29' to find unused x.x.x.x/29 CIDR range. The goal is to determine if one of the allocated ranges has enough free space for a subnet of the requested size. GCE disallows subnets with prefix_length > 29 "requestedRanges": [ # Optional. The name of one or more allocated IP address ranges associated with this private service access connection. If no range names are provided all ranges associated with this connection will be considered. If a CIDR range with the specified IP prefix length is not available within these ranges the validation fails. "A String", diff --git a/docs/dyn/tpu_v2alpha1.projects.locations.nodes.html b/docs/dyn/tpu_v2alpha1.projects.locations.nodes.html index fdddffa4a1f..0473ae82376 100644 --- a/docs/dyn/tpu_v2alpha1.projects.locations.nodes.html +++ b/docs/dyn/tpu_v2alpha1.projects.locations.nodes.html @@ -135,7 +135,7 @@Method Details
"autocheckpointEnabled": True or False, # Optional. Whether Autocheckpoint is enabled. "bootDiskConfig": { # Boot disk configurations. # Optional. Boot disk configuration. "customerEncryptionKey": { # Customer's encryption key. # Optional. Customer encryption key for boot disk. - "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1 }, "diskSizeGb": "A String", # Optional. Size of the boot disk in GB. It must be larger than or equal to the size of the image. "enableConfidentialCompute": True or False, # Optional. Whether the boot disk will be created with confidential compute mode. @@ -323,7 +323,7 @@Method Details
"autocheckpointEnabled": True or False, # Optional. Whether Autocheckpoint is enabled. "bootDiskConfig": { # Boot disk configurations. # Optional. Boot disk configuration. "customerEncryptionKey": { # Customer's encryption key. # Optional. Customer encryption key for boot disk. - "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1 }, "diskSizeGb": "A String", # Optional. Size of the boot disk in GB. It must be larger than or equal to the size of the image. "enableConfidentialCompute": True or False, # Optional. Whether the boot disk will be created with confidential compute mode. @@ -492,7 +492,7 @@Method Details
"autocheckpointEnabled": True or False, # Optional. Whether Autocheckpoint is enabled. "bootDiskConfig": { # Boot disk configurations. # Optional. Boot disk configuration. "customerEncryptionKey": { # Customer's encryption key. # Optional. Customer encryption key for boot disk. - "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1 }, "diskSizeGb": "A String", # Optional. Size of the boot disk in GB. It must be larger than or equal to the size of the image. "enableConfidentialCompute": True or False, # Optional. Whether the boot disk will be created with confidential compute mode. @@ -628,7 +628,7 @@Method Details
"autocheckpointEnabled": True or False, # Optional. Whether Autocheckpoint is enabled. "bootDiskConfig": { # Boot disk configurations. # Optional. Boot disk configuration. "customerEncryptionKey": { # Customer's encryption key. # Optional. Customer encryption key for boot disk. - "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1 }, "diskSizeGb": "A String", # Optional. Size of the boot disk in GB. It must be larger than or equal to the size of the image. "enableConfidentialCompute": True or False, # Optional. Whether the boot disk will be created with confidential compute mode. diff --git a/docs/dyn/tpu_v2alpha1.projects.locations.queuedResources.html b/docs/dyn/tpu_v2alpha1.projects.locations.queuedResources.html index 7d0caee8229..5df90148a0a 100644 --- a/docs/dyn/tpu_v2alpha1.projects.locations.queuedResources.html +++ b/docs/dyn/tpu_v2alpha1.projects.locations.queuedResources.html @@ -187,7 +187,7 @@Method Details
"autocheckpointEnabled": True or False, # Optional. Whether Autocheckpoint is enabled. "bootDiskConfig": { # Boot disk configurations. # Optional. Boot disk configuration. "customerEncryptionKey": { # Customer's encryption key. # Optional. Customer encryption key for boot disk. - "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1 }, "diskSizeGb": "A String", # Optional. Size of the boot disk in GB. It must be larger than or equal to the size of the image. "enableConfidentialCompute": True or False, # Optional. Whether the boot disk will be created with confidential compute mode. @@ -446,7 +446,7 @@Method Details
"autocheckpointEnabled": True or False, # Optional. Whether Autocheckpoint is enabled. "bootDiskConfig": { # Boot disk configurations. # Optional. Boot disk configuration. "customerEncryptionKey": { # Customer's encryption key. # Optional. Customer encryption key for boot disk. - "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1 }, "diskSizeGb": "A String", # Optional. Size of the boot disk in GB. It must be larger than or equal to the size of the image. "enableConfidentialCompute": True or False, # Optional. Whether the boot disk will be created with confidential compute mode. @@ -643,7 +643,7 @@Method Details
"autocheckpointEnabled": True or False, # Optional. Whether Autocheckpoint is enabled. "bootDiskConfig": { # Boot disk configurations. # Optional. Boot disk configuration. "customerEncryptionKey": { # Customer's encryption key. # Optional. Customer encryption key for boot disk. - "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 + "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: "kmsKeyName": "projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1 }, "diskSizeGb": "A String", # Optional. Size of the boot disk in GB. It must be larger than or equal to the size of the image. "enableConfidentialCompute": True or False, # Optional. Whether the boot disk will be created with confidential compute mode. diff --git a/docs/dyn/youtube_v3.youtube.v3.html b/docs/dyn/youtube_v3.youtube.v3.html index b9d6cb21646..6ea36da1c71 100644 --- a/docs/dyn/youtube_v3.youtube.v3.html +++ b/docs/dyn/youtube_v3.youtube.v3.html @@ -74,6 +74,11 @@YouTube Data API v3 . youtube . v3
Instance Methods
++
+liveChat()+Returns the liveChat Resource.
+Close httplib2 connections.
diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index 9b49dd909f7..67510eb028a 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -20253,7 +20253,7 @@ } } }, -"revision": "20250701", +"revision": "20250711", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -24470,6 +24470,10 @@ "description": "Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.", "type": "boolean" }, +"enableDatapointUpsertLogging": { +"description": "Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option.", +"type": "boolean" +}, "id": { "description": "Required. The user specified ID of the DeployedIndex. The ID can be up to 128 characters long and must start with a letter and only contain letters, numbers, and underscores. The ID must be unique within the project it is created in.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 436c123580f..d4a07ec4856 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -25262,7 +25262,7 @@ } } }, -"revision": "20250701", +"revision": "20250711", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -29900,6 +29900,10 @@ "description": "Optional. If true, private endpoint's access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each MatchRequest. Note that logs may incur a cost, especially if the deployed index receives a high queries per second rate (QPS). Estimate your costs before enabling this option.", "type": "boolean" }, +"enableDatapointUpsertLogging": { +"description": "Optional. If true, logs to Cloud Logging errors relating to datapoint upserts. Under normal operation conditions, these log entries should be very rare. However, if incompatible datapoint updates are being uploaded to an index, a high volume of log entries may be generated in a short period of time. Note that logs may incur a cost, especially if the deployed index receives a high volume of datapoint upserts. Estimate your costs before enabling this option.", +"type": "boolean" +}, "id": { "description": "Required. The user specified ID of the DeployedIndex. The ID can be up to 128 characters long and must start with a letter and only contain letters, numbers, and underscores. The ID must be unique within the project it is created in.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json index 60858ef405d..4cb8f1a0d81 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json @@ -683,24 +683,6 @@ "https://www.googleapis.com/auth/analytics.edit" ] }, -"createConnectedSiteTag": { -"description": "Creates a connected site tag for a Universal Analytics property. You can create a maximum of 20 connected site tags per property. Note: This API cannot be used on GA4 properties.", -"flatPath": "v1alpha/properties:createConnectedSiteTag", -"httpMethod": "POST", -"id": "analyticsadmin.properties.createConnectedSiteTag", -"parameterOrder": [], -"parameters": {}, -"path": "v1alpha/properties:createConnectedSiteTag", -"request": { -"$ref": "GoogleAnalyticsAdminV1alphaCreateConnectedSiteTagRequest" -}, -"response": { -"$ref": "GoogleAnalyticsAdminV1alphaCreateConnectedSiteTagResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/analytics.edit" -] -}, "createRollupProperty": { "description": "Create a roll-up property and all roll-up property source links.", "flatPath": "v1alpha/properties:createRollupProperty", @@ -744,65 +726,6 @@ "https://www.googleapis.com/auth/analytics.edit" ] }, -"deleteConnectedSiteTag": { -"description": "Deletes a connected site tag for a Universal Analytics property. Note: this has no effect on GA4 properties.", -"flatPath": "v1alpha/properties:deleteConnectedSiteTag", -"httpMethod": "POST", -"id": "analyticsadmin.properties.deleteConnectedSiteTag", -"parameterOrder": [], -"parameters": {}, -"path": "v1alpha/properties:deleteConnectedSiteTag", -"request": { -"$ref": "GoogleAnalyticsAdminV1alphaDeleteConnectedSiteTagRequest" -}, -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/analytics.edit" -] -}, -"fetchAutomatedGa4ConfigurationOptOut": { -"description": "Fetches the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.", -"flatPath": "v1alpha/properties:fetchAutomatedGa4ConfigurationOptOut", -"httpMethod": "POST", -"id": "analyticsadmin.properties.fetchAutomatedGa4ConfigurationOptOut", -"parameterOrder": [], -"parameters": {}, -"path": "v1alpha/properties:fetchAutomatedGa4ConfigurationOptOut", -"request": { -"$ref": "GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutRequest" -}, -"response": { -"$ref": "GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/analytics.edit", -"https://www.googleapis.com/auth/analytics.readonly" -] -}, -"fetchConnectedGa4Property": { -"description": "Given a specified UA property, looks up the GA4 property connected to it. Note: this cannot be used with GA4 properties.", -"flatPath": "v1alpha/properties:fetchConnectedGa4Property", -"httpMethod": "GET", -"id": "analyticsadmin.properties.fetchConnectedGa4Property", -"parameterOrder": [], -"parameters": { -"property": { -"description": "Required. The UA property for which to look up the connected GA4 property. Note this request uses the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format: properties/{internal_web_property_id} Example: properties/1234", -"location": "query", -"type": "string" -} -}, -"path": "v1alpha/properties:fetchConnectedGa4Property", -"response": { -"$ref": "GoogleAnalyticsAdminV1alphaFetchConnectedGa4PropertyResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/analytics.edit", -"https://www.googleapis.com/auth/analytics.readonly" -] -}, "get": { "description": "Lookup for a single GA Property.", "flatPath": "v1alpha/properties/{propertiesId}", @@ -971,25 +894,6 @@ "https://www.googleapis.com/auth/analytics.readonly" ] }, -"listConnectedSiteTags": { -"description": "Lists the connected site tags for a Universal Analytics property. A maximum of 20 connected site tags will be returned. Note: this has no effect on GA4 property.", -"flatPath": "v1alpha/properties:listConnectedSiteTags", -"httpMethod": "POST", -"id": "analyticsadmin.properties.listConnectedSiteTags", -"parameterOrder": [], -"parameters": {}, -"path": "v1alpha/properties:listConnectedSiteTags", -"request": { -"$ref": "GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest" -}, -"response": { -"$ref": "GoogleAnalyticsAdminV1alphaListConnectedSiteTagsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/analytics.edit", -"https://www.googleapis.com/auth/analytics.readonly" -] -}, "patch": { "description": "Updates a property.", "flatPath": "v1alpha/properties/{propertiesId}", @@ -1071,24 +975,6 @@ "https://www.googleapis.com/auth/analytics.readonly" ] }, -"setAutomatedGa4ConfigurationOptOut": { -"description": "Sets the opt out status for the automated GA4 setup process for a UA property. Note: this has no effect on GA4 property.", -"flatPath": "v1alpha/properties:setAutomatedGa4ConfigurationOptOut", -"httpMethod": "POST", -"id": "analyticsadmin.properties.setAutomatedGa4ConfigurationOptOut", -"parameterOrder": [], -"parameters": {}, -"path": "v1alpha/properties:setAutomatedGa4ConfigurationOptOut", -"request": { -"$ref": "GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutRequest" -}, -"response": { -"$ref": "GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/analytics.edit" -] -}, "updateAttributionSettings": { "description": "Updates attribution settings on a property.", "flatPath": "v1alpha/properties/{propertiesId}/attributionSettings", @@ -5172,7 +5058,7 @@ } } }, -"revision": "20250625", +"revision": "20250713", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -6765,21 +6651,6 @@ }, "type": "object" }, -"GoogleAnalyticsAdminV1alphaConnectedSiteTag": { -"description": "Configuration for a specific Connected Site Tag.", -"id": "GoogleAnalyticsAdminV1alphaConnectedSiteTag", -"properties": { -"displayName": { -"description": "Required. User-provided display name for the connected site tag. Must be less than 256 characters.", -"type": "string" -}, -"tagId": { -"description": "Required. \"Tag ID to forward events to. Also known as the Measurement ID, or the \"G-ID\" (For example: G-12345).", -"type": "string" -} -}, -"type": "object" -}, "GoogleAnalyticsAdminV1alphaConversionEvent": { "description": "A conversion event in a Google Analytics property.", "id": "GoogleAnalyticsAdminV1alphaConversionEvent", @@ -6904,27 +6775,6 @@ }, "type": "object" }, -"GoogleAnalyticsAdminV1alphaCreateConnectedSiteTagRequest": { -"description": "Request message for CreateConnectedSiteTag RPC.", -"id": "GoogleAnalyticsAdminV1alphaCreateConnectedSiteTagRequest", -"properties": { -"connectedSiteTag": { -"$ref": "GoogleAnalyticsAdminV1alphaConnectedSiteTag", -"description": "Required. The tag to add to the Universal Analytics property" -}, -"property": { -"description": "The Universal Analytics property to create connected site tags for. This API does not support GA4 properties. Format: properties/{universalAnalyticsPropertyId} Example: properties/1234", -"type": "string" -} -}, -"type": "object" -}, -"GoogleAnalyticsAdminV1alphaCreateConnectedSiteTagResponse": { -"description": "Response message for CreateConnectedSiteTag RPC.", -"id": "GoogleAnalyticsAdminV1alphaCreateConnectedSiteTagResponse", -"properties": {}, -"type": "object" -}, "GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest": { "description": "Request message for CreateRollupProperty RPC.", "id": "GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest", @@ -7324,21 +7174,6 @@ }, "type": "object" }, -"GoogleAnalyticsAdminV1alphaDeleteConnectedSiteTagRequest": { -"description": "Request message for DeleteConnectedSiteTag RPC.", -"id": "GoogleAnalyticsAdminV1alphaDeleteConnectedSiteTagRequest", -"properties": { -"property": { -"description": "The Universal Analytics property to delete connected site tags for. This API does not support GA4 properties. Format: properties/{universalAnalyticsPropertyId} Example: properties/1234", -"type": "string" -}, -"tagId": { -"description": "Tag ID to forward events to. Also known as the Measurement ID, or the \"G-ID\" (For example: G-12345).", -"type": "string" -} -}, -"type": "object" -}, "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink": { "description": "A link between a Google Analytics property and a Display & Video 360 advertiser.", "id": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink", @@ -7709,39 +7544,6 @@ }, "type": "object" }, -"GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutRequest": { -"description": "Request for fetching the opt out status for the automated GA4 setup process.", -"id": "GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutRequest", -"properties": { -"property": { -"description": "Required. The UA property to get the opt out status. Note this request uses the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format: properties/{internalWebPropertyId} Example: properties/1234", -"type": "string" -} -}, -"type": "object" -}, -"GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutResponse": { -"description": "Response message for fetching the opt out status for the automated GA4 setup process.", -"id": "GoogleAnalyticsAdminV1alphaFetchAutomatedGa4ConfigurationOptOutResponse", -"properties": { -"optOut": { -"description": "The opt out status for the UA property.", -"type": "boolean" -} -}, -"type": "object" -}, -"GoogleAnalyticsAdminV1alphaFetchConnectedGa4PropertyResponse": { -"description": "Response for looking up GA4 property connected to a UA property.", -"id": "GoogleAnalyticsAdminV1alphaFetchConnectedGa4PropertyResponse", -"properties": { -"property": { -"description": "The GA4 property connected to the UA property. An empty string is returned when there is no connected GA4 property. Format: properties/{property_id} Example: properties/1234", -"type": "string" -} -}, -"type": "object" -}, "GoogleAnalyticsAdminV1alphaFirebaseLink": { "description": "A link between a Google Analytics property and a Firebase project.", "id": "GoogleAnalyticsAdminV1alphaFirebaseLink", @@ -8138,31 +7940,6 @@ }, "type": "object" }, -"GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest": { -"description": "Request message for ListConnectedSiteTags RPC.", -"id": "GoogleAnalyticsAdminV1alphaListConnectedSiteTagsRequest", -"properties": { -"property": { -"description": "The Universal Analytics property to fetch connected site tags for. This does not work on GA4 properties. A maximum of 20 connected site tags will be returned. Example Format: `properties/1234`", -"type": "string" -} -}, -"type": "object" -}, -"GoogleAnalyticsAdminV1alphaListConnectedSiteTagsResponse": { -"description": "Response message for ListConnectedSiteTags RPC.", -"id": "GoogleAnalyticsAdminV1alphaListConnectedSiteTagsResponse", -"properties": { -"connectedSiteTags": { -"description": "The site tags for the Universal Analytics property. A maximum of 20 connected site tags will be returned.", -"items": { -"$ref": "GoogleAnalyticsAdminV1alphaConnectedSiteTag" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleAnalyticsAdminV1alphaListConversionEventsResponse": { "description": "Response message for ListConversionEvents RPC.", "id": "GoogleAnalyticsAdminV1alphaListConversionEventsResponse", @@ -9350,27 +9127,6 @@ }, "type": "object" }, -"GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutRequest": { -"description": "Request for setting the opt out status for the automated GA4 setup process.", -"id": "GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutRequest", -"properties": { -"optOut": { -"description": "The status to set.", -"type": "boolean" -}, -"property": { -"description": "Required. The UA property to set the opt out status. Note this request uses the internal property ID, not the tracking ID of the form UA-XXXXXX-YY. Format: properties/{internalWebPropertyId} Example: properties/1234", -"type": "string" -} -}, -"type": "object" -}, -"GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutResponse": { -"description": "Response message for setting the opt out status for the automated GA4 setup process.", -"id": "GoogleAnalyticsAdminV1alphaSetAutomatedGa4ConfigurationOptOutResponse", -"properties": {}, -"type": "object" -}, "GoogleAnalyticsAdminV1alphaSubpropertyEventFilter": { "description": "A resource message representing a Google Analytics subproperty event filter.", "id": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilter", diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index b6a585c84ad..bb362e53d55 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1260,7 +1260,7 @@ } } }, -"revision": "20250702", +"revision": "20250714", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -6085,8 +6085,8 @@ false "On Android 8 and below, only the network location provider is enabled. On Android 9 and above, this is equivalent to LOCATION_ENFORCED.", "On Android 8 and below, location setting and accuracy are disabled. On Android 9 and above, this is equivalent to LOCATION_DISABLED.", "Location setting is not restricted on the device. No specific behavior is set or enforced.", -"Enable location setting on the device.", -"Disable location setting on the device." +"Enable location setting on the device. Important: On Android 11 and above, work profiles on company-owned devices cannot directly enforce enabling of location services. When LOCATION_ENFORCED is set, then a NonComplianceDetail with USER_ACTION is reported. Compliance can only be restored once the user manually turns on location services through the device's Settings application. ", +"Disable location setting on the device. Important: On Android 11 and above, work profiles on company-owned devices cannot directly enforce disabling of location services. When LOCATION_DISABLED is set, then a nonComplianceDetail with USER_ACTION is reported. Compliance can only be restored once the user manually turns off location services through the device's Settings application. " ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index 8ba9611e61f..2e99bc668a2 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -1764,6 +1764,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"msComplianceMetadata": { +"description": "Returns the Assured Workloads compliance metadata for a given project.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers:msComplianceMetadata", +"httpMethod": "POST", +"id": "backupdr.projects.locations.managementServers.msComplianceMetadata", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The project and location to be used to check CSS metadata for target project information, in the format 'projects/{project_id}/locations/{location}'. In Cloud BackupDR, locations map to Google Cloud regions, for example **us-central1**.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/managementServers$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}:msComplianceMetadata", +"request": { +"$ref": "FetchMsComplianceMetadataRequest" +}, +"response": { +"$ref": "FetchMsComplianceMetadataResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:setIamPolicy", @@ -2032,7 +2060,7 @@ } } }, -"revision": "20250625", +"revision": "20250711", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -3552,7 +3580,7 @@ "type": "string" }, "disks": { -"description": "Optional. Array of disks associated with this instance. Persistent disks must be created before you can assign them.", +"description": "Optional. Array of disks associated with this instance. Persistent disks must be created before you can assign them. Source regional persistent disks will be restored with default replica zones if not specified.", "items": { "$ref": "AttachedDisk" }, @@ -3615,7 +3643,7 @@ "type": "string" }, "networkInterfaces": { -"description": "Optional. An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.", +"description": "Optional. An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. Required to restore in different project or region.", "items": { "$ref": "NetworkInterface" }, @@ -3650,7 +3678,7 @@ "description": "Optional. Specifies the reservations that this instance can consume from." }, "resourcePolicies": { -"description": "Optional. Resource policies applied to this instance.", +"description": "Optional. Resource policies applied to this instance. By default, no resource policies will be applied.", "items": { "type": "string" }, @@ -4352,6 +4380,28 @@ }, "type": "object" }, +"FetchMsComplianceMetadataRequest": { +"description": "Request message for GetMsComplianceMetadata", +"id": "FetchMsComplianceMetadataRequest", +"properties": { +"projectId": { +"description": "Required. The project id of the target project", +"type": "string" +} +}, +"type": "object" +}, +"FetchMsComplianceMetadataResponse": { +"description": "Response message for GetMsComplianceMetadata", +"id": "FetchMsComplianceMetadataResponse", +"properties": { +"isAssuredWorkload": { +"description": "The ms compliance metadata of the target project, if the project is an assured workloads project, values will be true, otherwise false.", +"type": "boolean" +} +}, +"type": "object" +}, "FetchUsableBackupVaultsResponse": { "description": "Response message for fetching usable BackupVaults.", "id": "FetchUsableBackupVaultsResponse", diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json index 3848aed173f..47b57ea16e5 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json @@ -1899,7 +1899,7 @@ } } }, -"revision": "20250616", +"revision": "20250714", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -3160,6 +3160,53 @@ "format": "google-datetime", "readOnly": true, "type": "string" +}, +"upstreams": { +"description": "Optional. Which upstream resources to forward traffic to.", +"items": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstream" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstream": { +"description": "Which upstream resource to forward traffic to.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstream", +"properties": { +"egressPolicy": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1EgressPolicy", +"description": "Optional. Routing policy information." +}, +"network": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamNetwork", +"description": "Network to forward traffic to." +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamNetwork": { +"description": "Network to forward traffic to.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1ApplicationUpstreamNetwork", +"properties": { +"name": { +"description": "Required. Network name is of the format: `projects/{project}/global/networks/{network}", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1EgressPolicy": { +"description": "Routing policy information.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1EgressPolicy", +"properties": { +"regions": { +"description": "Required. List of the regions where the application sends traffic.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -3269,6 +3316,11 @@ "readOnly": true, "type": "string" }, +"delegatingServiceAccount": { +"description": "Output only. Service account used for operations that involve resources in consumer projects.", +"readOnly": true, +"type": "string" +}, "displayName": { "description": "Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json index 1f0a3faf5b0..80f0a2b8d59 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json @@ -3432,7 +3432,7 @@ } } }, -"revision": "20250616", +"revision": "20250714", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -5508,6 +5508,53 @@ "format": "google-datetime", "readOnly": true, "type": "string" +}, +"upstreams": { +"description": "Optional. Which upstream resources to forward traffic to.", +"items": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstream" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstream": { +"description": "Which upstream resource to forward traffic to.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstream", +"properties": { +"egressPolicy": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEgressPolicy", +"description": "Optional. Routing policy information." +}, +"network": { +"$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstreamNetwork", +"description": "Network to forward traffic to." +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstreamNetwork": { +"description": "Network to forward traffic to.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationUpstreamNetwork", +"properties": { +"name": { +"description": "Required. Network name is of the format: `projects/{project}/global/networks/{network}", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudBeyondcorpSecuritygatewaysV1alphaEgressPolicy": { +"description": "Routing policy information.", +"id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEgressPolicy", +"properties": { +"regions": { +"description": "Required. List of the regions where the application sends traffic.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -5617,6 +5664,11 @@ "readOnly": true, "type": "string" }, +"delegatingServiceAccount": { +"description": "Output only. Service account used for operations that involve resources in consumer projects.", +"readOnly": true, +"type": "string" +}, "displayName": { "description": "Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index d636d609e2f..2a559a0efe8 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -1528,7 +1528,7 @@ } } }, -"revision": "20250706", +"revision": "20250710", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -2019,18 +2019,18 @@ "type": "object" }, "CommonEventObject": { -"description": "Represents information about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes data submitted by users interacting with cards, like data entered in [dialogs](https://developers.google.com/chat/how-tos/dialogs).", +"description": "The common event object is the portion of the overall event object that carries general, host-independent information to the add-on from the user's client. This information includes details such as the user's locale, host app, and platform. In addition to homepage and contextual triggers, add-ons construct and pass event objects to [action callback functions](https://developers.google.com/workspace/add-ons/concepts/actions#callback_functions) when the user interacts with widgets. Your add-on's callback function can query the common event object to determine the contents of open widgets in the user's client. For example, your add-on can locate the text a user has entered into a [TextInput](https://developers.google.com/apps-script/reference/card-service/text-input) widget in the `eventObject.commentEventObject.formInputs` object. For Chat apps, the name of the function that the user invoked when interacting with a widget.", "id": "CommonEventObject", "properties": { "formInputs": { "additionalProperties": { "$ref": "Inputs" }, -"description": "A map containing the values that a user inputs in a widget from a card or dialog. The map keys are the string IDs assigned to each widget, and the values represent inputs to the widget. For details, see [Process information inputted by users](https://developers.google.com/chat/ui/read-form-data).", +"description": "A map containing the current values of the widgets in the displayed card. The map keys are the string IDs assigned with each widget. The structure of the map value object is dependent on the widget type: **Note**: The following examples are formatted for Apps Script's V8 runtime. If you're using Rhino runtime, you must add `[\"\"]` after the value. For example, instead of `e.commonEventObject.formInputs.employeeName.stringInputs.value[0]`, format the event object as `e.commonEventObject.formInputs.employeeName[\"\"].stringInputs.value[0]`. To learn more about runtimes in Apps Script, see the [V8 Runtime Overview](https://developers.google.com/apps-script/guides/v8-runtime). * Single-valued widgets (for example, a text box): a list of strings (only one element). **Example**: for a text input widget with `employeeName` as its ID, access the text input value with: `e.commonEventObject.formInputs.employeeName.stringInputs.value[0]`. * Multi-valued widgets (for example, checkbox groups): a list of strings. **Example**: for a multi-value widget with `participants` as its ID, access the value array with: `e.commonEventObject.formInputs.participants.stringInputs.value`. * **A date-time picker**: a [`DateTimeInput object`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-time-input). **Example**: For a picker with an ID of `myDTPicker`, access the [`DateTimeInput`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-time-input) object using `e.commonEventObject.formInputs.myDTPicker.dateTimeInput`. * **A date-only picker**: a [`DateInput object`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-input). **Example**: For a picker with an ID of `myDatePicker`, access the [`DateInput`](https://developers.google.com/workspace/add-ons/concepts/event-objects#date-input) object using `e.commonEventObject.formInputs.myDatePicker.dateInput`. * **A time-only picker**: a [`TimeInput object`](https://developers.google.com/workspace/add-ons/concepts/event-objects#time-input). **Example**: For a picker with an ID of `myTimePicker`, access the [`TimeInput`](https://developers.google.com/workspace/add-ons/concepts/event-objects#time-input) object using `e.commonEventObject.formInputs.myTimePicker.timeInput`.", "type": "object" }, "hostApp": { -"description": "The hostApp enum which indicates the app the add-on is invoked from. Always `CHAT` for Chat apps.", +"description": "Indicates the host app the add-on is active in when the event object is generated. Possible values include the following: * `GMAIL` * `CALENDAR` * `DRIVE` * `DOCS` * `SHEETS` * `SLIDES` * `CHAT`", "enum": [ "UNSPECIFIED_HOST_APP", "GMAIL", @@ -2067,7 +2067,7 @@ "additionalProperties": { "type": "string" }, -"description": "Custom [parameters](/chat/api/reference/rest/v1/cards#ActionParameter) passed to the invoked function. Both keys and values must be strings.", +"description": "Any additional parameters you supply to an action using [`actionParameters`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#google.apps.card.v1.Action.ActionParameter) or [`Action.setParameters()`](https://developers.google.com/apps-script/reference/card-service/action#setparametersparameters). **Developer Preview:** For [add-ons that extend Google Chat](https://developers.google.com/workspace/add-ons/chat), to suggest items based on what the users type in multiselect menus, use the value of the `\"autocomplete_widget_query\"` key (`event.commonEventObject.parameters[\"autocomplete_widget_query\"]`). You can use this value to query a database and suggest selectable items to users as they type. For details, see [Collect and process information from Google Chat users](https://developers.google.com/workspace/add-ons/chat/collect-information).", "type": "object" }, "platform": { @@ -2088,10 +2088,10 @@ }, "timeZone": { "$ref": "TimeZone", -"description": "The timezone ID and offset from Coordinated Universal Time (UTC). Only supported for the event types [`CARD_CLICKED`](https://developers.google.com/chat/api/reference/rest/v1/EventType#ENUM_VALUES.CARD_CLICKED) and [`SUBMIT_DIALOG`](https://developers.google.com/chat/api/reference/rest/v1/DialogEventType#ENUM_VALUES.SUBMIT_DIALOG)." +"description": "**Disabled by default.** The timezone ID and offset from Coordinated Universal Time (UTC). To turn on this field, you must set `addOns.common.useLocaleFromApp` to `true` in your add-on's manifest. Your add-on's scope list must also include `https://www.googleapis.com/auth/script.locale`. See [Accessing user locale and timezone](https://developers.google.com/workspace/add-ons/how-tos/access-user-locale) for more details. Only supported for the event types [`CARD_CLICKED`](https://developers.google.com/chat/api/reference/rest/v1/EventType#ENUM_VALUES.CARD_CLICKED) and [`SUBMIT_DIALOG`](https://developers.google.com/chat/api/reference/rest/v1/DialogEventType#ENUM_VALUES.SUBMIT_DIALOG)." }, "userLocale": { -"description": "The full `locale.displayName` in the format of [ISO 639 language code]-[ISO 3166 country/region code] such as \"en-US\".", +"description": "**Disabled by default.** The user's language and country/region identifier in the format of [ISO 639](https://wikipedia.org/wiki/ISO_639_macrolanguage) language code-[ISO 3166](https://wikipedia.org/wiki/ISO_3166) country/region code. For example, `en-US`. To turn on this field, you must set `addOns.common.useLocaleFromApp` to `true` in your add-on's manifest. Your add-on's scope list must also include `https://www.googleapis.com/auth/script.locale`. See [Accessing user locale and timezone](https://developers.google.com/workspace/add-ons/how-tos/access-user-locale) for more details.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1.json index 59249f8378f..1a913b9db46 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1.json @@ -1095,7 +1095,7 @@ } } }, -"revision": "20250627", +"revision": "20250711", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { @@ -1323,6 +1323,13 @@ }, "type": "array" }, +"assetExceptions": { +"description": "The exceptions of a resource.", +"items": { +"$ref": "AssetException" +}, +"type": "array" +}, "assetType": { "description": "The type of the asset. Example: `compute.googleapis.com/Disk` See [Supported asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) for more information.", "type": "string" @@ -1382,6 +1389,29 @@ }, "type": "object" }, +"AssetException": { +"description": "An exception of an asset.", +"id": "AssetException", +"properties": { +"details": { +"description": "The details of the exception.", +"type": "string" +}, +"exceptionType": { +"description": "The type of exception.", +"enum": [ +"EXCEPTION_TYPE_UNSPECIFIED", +"TRUNCATION" +], +"enumDescriptions": [ +"exception_type is not applicable for the current asset.", +"The asset content is truncated." +], +"type": "string" +} +}, +"type": "object" +}, "AttachedResource": { "description": "Attached resource representation, which is defined by the corresponding service provider. It represents an attached resource's payload.", "id": "AttachedResource", diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index 19023304841..d7525a1483a 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -50444,7 +50444,7 @@ } } }, -"revision": "20250708", +"revision": "20250717", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -51886,6 +51886,10 @@ false "$ref": "AllocationResourceStatusAggregateAllocation", "description": "Properties of this aggregatereservation." }, +"healthInfo": { +"$ref": "AllocationResourceStatusHealthInfo", +"description": "[Output only] Health information for the reservation." +}, "reservationBlockCount": { "description": "The number of reservation blocks associated with this reservation.", "format": "int32", @@ -51917,6 +51921,37 @@ false }, "type": "object" }, +"AllocationResourceStatusHealthInfo": { +"description": "Health information for the reservation.", +"id": "AllocationResourceStatusHealthInfo", +"properties": { +"degradedBlockCount": { +"description": "The number of reservation blocks that are degraded.", +"format": "int32", +"type": "integer" +}, +"healthStatus": { +"description": "The health status of the reservation.", +"enum": [ +"DEGRADED", +"HEALTHY", +"HEALTH_STATUS_UNSPECIFIED" +], +"enumDescriptions": [ +"The reservation is degraded.", +"The reservation is healthy.", +"The health status of the reservation is unspecified." +], +"type": "string" +}, +"healthyBlockCount": { +"description": "The number of reservation blocks that are healthy.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "AllocationResourceStatusSpecificSKUAllocation": { "description": "Contains Properties set for the reservation.", "id": "AllocationResourceStatusSpecificSKUAllocation", @@ -94875,6 +94910,10 @@ false "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, +"healthInfo": { +"$ref": "ReservationBlockHealthInfo", +"description": "[Output Only] Health information for the reservation block." +}, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "format": "uint64", @@ -94948,6 +94987,37 @@ false }, "type": "object" }, +"ReservationBlockHealthInfo": { +"description": "Health information for the reservation block.", +"id": "ReservationBlockHealthInfo", +"properties": { +"degradedSubBlockCount": { +"description": "The number of subBlocks that are degraded.", +"format": "int32", +"type": "integer" +}, +"healthStatus": { +"description": "The health status of the reservation block.", +"enum": [ +"DEGRADED", +"HEALTHY", +"HEALTH_STATUS_UNSPECIFIED" +], +"enumDescriptions": [ +"The reservation block is degraded.", +"The reservation block is healthy.", +"The health status of the reservation block is unspecified." +], +"type": "string" +}, +"healthySubBlockCount": { +"description": "The number of subBlocks that are healthy.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "ReservationBlockPhysicalTopology": { "id": "ReservationBlockPhysicalTopology", "properties": { @@ -95336,6 +95406,10 @@ false "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, +"healthInfo": { +"$ref": "ReservationSubBlockHealthInfo", +"description": "[Output Only] Health information for the reservation subBlock." +}, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "format": "uint64", @@ -95394,6 +95468,47 @@ false }, "type": "object" }, +"ReservationSubBlockHealthInfo": { +"description": "Health information for the reservation subBlock.", +"id": "ReservationSubBlockHealthInfo", +"properties": { +"degradedHostCount": { +"description": "The number of degraded hosts in the reservation subBlock.", +"format": "int32", +"type": "integer" +}, +"degradedInfraCount": { +"description": "The number of degraded infrastructure (e.g NV link domain) in the reservation subblock.", +"format": "int32", +"type": "integer" +}, +"healthStatus": { +"description": "The health status of the reservation subBlock.", +"enum": [ +"DEGRADED", +"HEALTHY", +"HEALTH_STATUS_UNSPECIFIED" +], +"enumDescriptions": [ +"The reservation subBlock is degraded.", +"The reservation subBlock is healthy.", +"The health status of the reservation subBlock is unspecified." +], +"type": "string" +}, +"healthyHostCount": { +"description": "The number of healthy hosts in the reservation subBlock.", +"format": "int32", +"type": "integer" +}, +"healthyInfraCount": { +"description": "The number of healthy infrastructure (e.g NV link domain) in the reservation subblock.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "ReservationSubBlockPhysicalTopology": { "id": "ReservationSubBlockPhysicalTopology", "properties": { diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index 87712e1c7b6..c637465cee4 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -45720,7 +45720,7 @@ } } }, -"revision": "20250708", +"revision": "20250717", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -47125,6 +47125,10 @@ false "description": "[Output Only] Contains output only fields.", "id": "AllocationResourceStatus", "properties": { +"healthInfo": { +"$ref": "AllocationResourceStatusHealthInfo", +"description": "[Output only] Health information for the reservation." +}, "reservationBlockCount": { "description": "The number of reservation blocks associated with this reservation.", "format": "int32", @@ -47141,6 +47145,37 @@ false }, "type": "object" }, +"AllocationResourceStatusHealthInfo": { +"description": "Health information for the reservation.", +"id": "AllocationResourceStatusHealthInfo", +"properties": { +"degradedBlockCount": { +"description": "The number of reservation blocks that are degraded.", +"format": "int32", +"type": "integer" +}, +"healthStatus": { +"description": "The health status of the reservation.", +"enum": [ +"DEGRADED", +"HEALTHY", +"HEALTH_STATUS_UNSPECIFIED" +], +"enumDescriptions": [ +"The reservation is degraded.", +"The reservation is healthy.", +"The health status of the reservation is unspecified." +], +"type": "string" +}, +"healthyBlockCount": { +"description": "The number of reservation blocks that are healthy.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "AllocationResourceStatusSpecificSKUAllocation": { "description": "Contains Properties set for the reservation.", "id": "AllocationResourceStatusSpecificSKUAllocation", @@ -82963,6 +82998,20 @@ false "description": "[Output Only] Reserved for future use.", "type": "boolean" }, +"schedulingType": { +"description": "The type of maintenance for the reservation.", +"enum": [ +"GROUPED", +"GROUP_MAINTENANCE_TYPE_UNSPECIFIED", +"INDEPENDENT" +], +"enumDescriptions": [ +"Maintenance on all reserved instances in the reservation is synchronized.", +"Unknown maintenance type.", +"Maintenance is not synchronized for this reservation. Instead, each instance has its own maintenance window." +], +"type": "string" +}, "selfLink": { "description": "[Output Only] Server-defined fully-qualified URL for this resource.", "type": "string" @@ -83218,6 +83267,10 @@ false "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, +"healthInfo": { +"$ref": "ReservationBlockHealthInfo", +"description": "[Output Only] Health information for the reservation block." +}, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "format": "uint64", @@ -83286,6 +83339,37 @@ false }, "type": "object" }, +"ReservationBlockHealthInfo": { +"description": "Health information for the reservation block.", +"id": "ReservationBlockHealthInfo", +"properties": { +"degradedSubBlockCount": { +"description": "The number of subBlocks that are degraded.", +"format": "int32", +"type": "integer" +}, +"healthStatus": { +"description": "The health status of the reservation block.", +"enum": [ +"DEGRADED", +"HEALTHY", +"HEALTH_STATUS_UNSPECIFIED" +], +"enumDescriptions": [ +"The reservation block is degraded.", +"The reservation block is healthy.", +"The health status of the reservation block is unspecified." +], +"type": "string" +}, +"healthySubBlockCount": { +"description": "The number of subBlocks that are healthy.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "ReservationBlockPhysicalTopology": { "id": "ReservationBlockPhysicalTopology", "properties": { @@ -83674,6 +83758,10 @@ false "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, +"healthInfo": { +"$ref": "ReservationSubBlockHealthInfo", +"description": "[Output Only] Health information for the reservation subBlock." +}, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "format": "uint64", @@ -83732,6 +83820,47 @@ false }, "type": "object" }, +"ReservationSubBlockHealthInfo": { +"description": "Health information for the reservation subBlock.", +"id": "ReservationSubBlockHealthInfo", +"properties": { +"degradedHostCount": { +"description": "The number of degraded hosts in the reservation subBlock.", +"format": "int32", +"type": "integer" +}, +"degradedInfraCount": { +"description": "The number of degraded infrastructure (e.g NV link domain) in the reservation subblock.", +"format": "int32", +"type": "integer" +}, +"healthStatus": { +"description": "The health status of the reservation subBlock.", +"enum": [ +"DEGRADED", +"HEALTHY", +"HEALTH_STATUS_UNSPECIFIED" +], +"enumDescriptions": [ +"The reservation subBlock is degraded.", +"The reservation subBlock is healthy.", +"The health status of the reservation subBlock is unspecified." +], +"type": "string" +}, +"healthyHostCount": { +"description": "The number of healthy hosts in the reservation subBlock.", +"format": "int32", +"type": "integer" +}, +"healthyInfraCount": { +"description": "The number of healthy infrastructure (e.g NV link domain) in the reservation subblock.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "ReservationSubBlockPhysicalTopology": { "id": "ReservationSubBlockPhysicalTopology", "properties": { @@ -99228,6 +99357,39 @@ false "description": "Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.", "type": "boolean" }, +"maintenanceReasons": { +"description": "The reasons for the maintenance. Only valid for vms.", +"items": { +"enum": [ +"FAILURE_DISK", +"FAILURE_GPU", +"FAILURE_GPU_TEMPERATURE", +"FAILURE_GPU_XID", +"FAILURE_INFRA", +"FAILURE_INTERFACE", +"FAILURE_MEMORY", +"FAILURE_NETWORK", +"FAILURE_NVLINK", +"INFRASTRUCTURE_RELOCATION", +"MAINTENANCE_REASON_UNKNOWN" +], +"enumDescriptions": [ +"Maintenance due to disk errors.", +"Maintenance due to GPU errors.", +"Maintenance due to high GPU temperature.", +"Maintenance due to GPU xid failure.", +"Maintenance due to infrastructure errors.", +"Maintenance due to interface errors.", +"Maintenance due to memory errors.", +"Maintenance due to network errors.", +"Maintenance due to NVLink failure.", +"Maintenance due to infrastructure relocation.", +"Unknown maintenance reason. Do not use this value." +], +"type": "string" +}, +"type": "array" +}, "maintenanceStatus": { "enum": [ "ONGOING", diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index f9a69727425..8f1e4f65f60 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -39950,7 +39950,7 @@ } } }, -"revision": "20250708", +"revision": "20250717", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -41355,6 +41355,10 @@ false "description": "[Output Only] Contains output only fields.", "id": "AllocationResourceStatus", "properties": { +"healthInfo": { +"$ref": "AllocationResourceStatusHealthInfo", +"description": "[Output only] Health information for the reservation." +}, "reservationBlockCount": { "description": "The number of reservation blocks associated with this reservation.", "format": "int32", @@ -41371,6 +41375,37 @@ false }, "type": "object" }, +"AllocationResourceStatusHealthInfo": { +"description": "Health information for the reservation.", +"id": "AllocationResourceStatusHealthInfo", +"properties": { +"degradedBlockCount": { +"description": "The number of reservation blocks that are degraded.", +"format": "int32", +"type": "integer" +}, +"healthStatus": { +"description": "The health status of the reservation.", +"enum": [ +"DEGRADED", +"HEALTHY", +"HEALTH_STATUS_UNSPECIFIED" +], +"enumDescriptions": [ +"The reservation is degraded.", +"The reservation is healthy.", +"The health status of the reservation is unspecified." +], +"type": "string" +}, +"healthyBlockCount": { +"description": "The number of reservation blocks that are healthy.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "AllocationResourceStatusSpecificSKUAllocation": { "description": "Contains Properties set for the reservation.", "id": "AllocationResourceStatusSpecificSKUAllocation", @@ -73544,6 +73579,20 @@ false "description": "[Output Only] Reserved for future use.", "type": "boolean" }, +"schedulingType": { +"description": "The type of maintenance for the reservation.", +"enum": [ +"GROUPED", +"GROUP_MAINTENANCE_TYPE_UNSPECIFIED", +"INDEPENDENT" +], +"enumDescriptions": [ +"Maintenance on all reserved instances in the reservation is synchronized.", +"Unknown maintenance type.", +"Maintenance is not synchronized for this reservation. Instead, each instance has its own maintenance window." +], +"type": "string" +}, "selfLink": { "description": "[Output Only] Server-defined fully-qualified URL for this resource.", "type": "string" @@ -73795,6 +73844,10 @@ false "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, +"healthInfo": { +"$ref": "ReservationBlockHealthInfo", +"description": "[Output Only] Health information for the reservation block." +}, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "format": "uint64", @@ -73863,6 +73916,37 @@ false }, "type": "object" }, +"ReservationBlockHealthInfo": { +"description": "Health information for the reservation block.", +"id": "ReservationBlockHealthInfo", +"properties": { +"degradedSubBlockCount": { +"description": "The number of subBlocks that are degraded.", +"format": "int32", +"type": "integer" +}, +"healthStatus": { +"description": "The health status of the reservation block.", +"enum": [ +"DEGRADED", +"HEALTHY", +"HEALTH_STATUS_UNSPECIFIED" +], +"enumDescriptions": [ +"The reservation block is degraded.", +"The reservation block is healthy.", +"The health status of the reservation block is unspecified." +], +"type": "string" +}, +"healthySubBlockCount": { +"description": "The number of subBlocks that are healthy.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "ReservationBlockPhysicalTopology": { "id": "ReservationBlockPhysicalTopology", "properties": { @@ -74251,6 +74335,10 @@ false "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, +"healthInfo": { +"$ref": "ReservationSubBlockHealthInfo", +"description": "[Output Only] Health information for the reservation subBlock." +}, "id": { "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", "format": "uint64", @@ -74309,6 +74397,47 @@ false }, "type": "object" }, +"ReservationSubBlockHealthInfo": { +"description": "Health information for the reservation subBlock.", +"id": "ReservationSubBlockHealthInfo", +"properties": { +"degradedHostCount": { +"description": "The number of degraded hosts in the reservation subBlock.", +"format": "int32", +"type": "integer" +}, +"degradedInfraCount": { +"description": "The number of degraded infrastructure (e.g NV link domain) in the reservation subblock.", +"format": "int32", +"type": "integer" +}, +"healthStatus": { +"description": "The health status of the reservation subBlock.", +"enum": [ +"DEGRADED", +"HEALTHY", +"HEALTH_STATUS_UNSPECIFIED" +], +"enumDescriptions": [ +"The reservation subBlock is degraded.", +"The reservation subBlock is healthy.", +"The health status of the reservation subBlock is unspecified." +], +"type": "string" +}, +"healthyHostCount": { +"description": "The number of healthy hosts in the reservation subBlock.", +"format": "int32", +"type": "integer" +}, +"healthyInfraCount": { +"description": "The number of healthy infrastructure (e.g NV link domain) in the reservation subblock.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "ReservationSubBlockPhysicalTopology": { "id": "ReservationSubBlockPhysicalTopology", "properties": { @@ -88775,6 +88904,43 @@ false "description": "The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.", "type": "string" }, +"maintenanceOnShutdown": { +"description": "Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.", +"type": "boolean" +}, +"maintenanceReasons": { +"description": "The reasons for the maintenance. Only valid for vms.", +"items": { +"enum": [ +"FAILURE_DISK", +"FAILURE_GPU", +"FAILURE_GPU_TEMPERATURE", +"FAILURE_GPU_XID", +"FAILURE_INFRA", +"FAILURE_INTERFACE", +"FAILURE_MEMORY", +"FAILURE_NETWORK", +"FAILURE_NVLINK", +"INFRASTRUCTURE_RELOCATION", +"MAINTENANCE_REASON_UNKNOWN" +], +"enumDescriptions": [ +"Maintenance due to disk errors.", +"Maintenance due to GPU errors.", +"Maintenance due to high GPU temperature.", +"Maintenance due to GPU xid failure.", +"Maintenance due to infrastructure errors.", +"Maintenance due to interface errors.", +"Maintenance due to memory errors.", +"Maintenance due to network errors.", +"Maintenance due to NVLink failure.", +"Maintenance due to infrastructure relocation.", +"Unknown maintenance reason. Do not use this value." +], +"type": "string" +}, +"type": "array" +}, "maintenanceStatus": { "enum": [ "ONGOING", diff --git a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json index b6dd75d8da6..bb160a27422 100644 --- a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json +++ b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json @@ -693,41 +693,6 @@ "https://www.googleapis.com/auth/compute" ] }, -"getWorkerStacktraces": { -"description": "Get worker stacktraces from debug capture.", -"flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getWorkerStacktraces", -"httpMethod": "POST", -"id": "dataflow.projects.jobs.debug.getWorkerStacktraces", -"parameterOrder": [ -"projectId", -"jobId" -], -"parameters": { -"jobId": { -"description": "The job for which to get stacktraces.", -"location": "path", -"required": true, -"type": "string" -}, -"projectId": { -"description": "The project id.", -"location": "path", -"required": true, -"type": "string" -} -}, -"path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getWorkerStacktraces", -"request": { -"$ref": "GetWorkerStacktracesRequest" -}, -"response": { -"$ref": "GetWorkerStacktracesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, "sendCapture": { "description": "Send encoded debug capture data for component.", "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture", @@ -1433,6 +1398,48 @@ "https://www.googleapis.com/auth/compute" ] }, +"getWorkerStacktraces": { +"description": "Get worker stacktraces from debug capture.", +"flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getWorkerStacktraces", +"httpMethod": "POST", +"id": "dataflow.projects.locations.jobs.debug.getWorkerStacktraces", +"parameterOrder": [ +"projectId", +"location", +"jobId" +], +"parameters": { +"jobId": { +"description": "The job for which to get stacktraces.", +"location": "path", +"required": true, +"type": "string" +}, +"location": { +"description": "The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.", +"location": "path", +"required": true, +"type": "string" +}, +"projectId": { +"description": "The project id.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getWorkerStacktraces", +"request": { +"$ref": "GetWorkerStacktracesRequest" +}, +"response": { +"$ref": "GetWorkerStacktracesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "sendCapture": { "description": "Send encoded debug capture data for component.", "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture", @@ -2243,7 +2250,7 @@ } } }, -"revision": "20250519", +"revision": "20250716", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { diff --git a/googleapiclient/discovery_cache/documents/datalineage.v1.json b/googleapiclient/discovery_cache/documents/datalineage.v1.json index 8e3285b63a6..2df8d31c235 100644 --- a/googleapiclient/discovery_cache/documents/datalineage.v1.json +++ b/googleapiclient/discovery_cache/documents/datalineage.v1.json @@ -4,9 +4,6 @@ "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." -}, -"https://www.googleapis.com/auth/cloud-platform.read-only": { -"description": "View your data across Google Cloud services and see the email address of your Google Account" } } } @@ -101,6 +98,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://datalineage.europe-north3.rep.googleapis.com/", +"location": "europe-north3" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://datalineage.europe-southwest1.rep.googleapis.com/", "location": "europe-southwest1" }, @@ -384,8 +386,7 @@ "$ref": "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "processOpenLineageRunEvent": { @@ -422,8 +423,7 @@ "$ref": "GoogleCloudDatacatalogLineageV1ProcessOpenLineageRunEventResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "searchLinks": { @@ -451,8 +451,7 @@ "$ref": "GoogleCloudDatacatalogLineageV1SearchLinksResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } }, @@ -484,8 +483,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -510,8 +508,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -536,8 +533,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -578,8 +574,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -616,8 +611,7 @@ "$ref": "GoogleCloudDatacatalogLineageV1Process" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -647,8 +641,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -673,8 +666,7 @@ "$ref": "GoogleCloudDatacatalogLineageV1Process" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -710,8 +702,7 @@ "$ref": "GoogleCloudDatacatalogLineageV1ListProcessesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -755,8 +746,7 @@ "$ref": "GoogleCloudDatacatalogLineageV1Process" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } }, @@ -793,8 +783,7 @@ "$ref": "GoogleCloudDatacatalogLineageV1Run" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -824,8 +813,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -850,8 +838,7 @@ "$ref": "GoogleCloudDatacatalogLineageV1Run" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -887,8 +874,7 @@ "$ref": "GoogleCloudDatacatalogLineageV1ListRunsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -927,8 +913,7 @@ "$ref": "GoogleCloudDatacatalogLineageV1Run" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } }, @@ -965,8 +950,7 @@ "$ref": "GoogleCloudDatacatalogLineageV1LineageEvent" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -996,8 +980,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -1022,8 +1005,7 @@ "$ref": "GoogleCloudDatacatalogLineageV1LineageEvent" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -1059,8 +1041,7 @@ "$ref": "GoogleCloudDatacatalogLineageV1ListLineageEventsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -1074,7 +1055,7 @@ } } }, -"revision": "20250710", +"revision": "20250711", "rootUrl": "https://datalineage.googleapis.com/", "schemas": { "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest": { diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json index 1e52a209ca7..cfabf321ec9 100644 --- a/googleapiclient/discovery_cache/documents/dataplex.v1.json +++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json @@ -4,9 +4,6 @@ "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." -}, -"https://www.googleapis.com/auth/cloud-platform.read-only": { -"description": "View your data across Google Cloud services and see the email address of your Google Account" } } } @@ -381,8 +378,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -412,8 +408,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -438,8 +433,7 @@ "$ref": "GoogleCloudDataplexV1EncryptionConfig" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { @@ -470,8 +464,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -517,8 +510,7 @@ "$ref": "GoogleCloudDataplexV1ListEncryptionConfigsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -552,8 +544,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -581,8 +572,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -610,8 +600,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -643,8 +632,7 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -669,8 +657,7 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -695,8 +682,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -737,8 +723,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -773,8 +758,7 @@ "$ref": "GoogleCloudLocationLocation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -821,8 +805,7 @@ "$ref": "GoogleCloudLocationListLocationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "lookupEntry": { @@ -883,8 +866,7 @@ "$ref": "GoogleCloudDataplexV1Entry" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "searchEntries": { @@ -940,8 +922,7 @@ "$ref": "GoogleCloudDataplexV1SearchEntriesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } }, @@ -983,8 +964,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -1014,8 +994,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -1040,8 +1019,7 @@ "$ref": "GoogleCloudDataplexV1AspectType" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { @@ -1072,8 +1050,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -1119,8 +1096,7 @@ "$ref": "GoogleCloudDataplexV1ListAspectTypesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -1159,8 +1135,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -1188,8 +1163,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -1217,8 +1191,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -1261,8 +1234,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -1293,8 +1265,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -1320,8 +1291,7 @@ "$ref": "GoogleCloudDataplexV1DataAttributeBinding" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { @@ -1352,8 +1322,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -1400,8 +1369,7 @@ "$ref": "GoogleCloudDataplexV1ListDataAttributeBindingsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -1441,8 +1409,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -1470,8 +1437,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -1499,8 +1465,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -1542,8 +1507,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -1573,8 +1537,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "generateDataQualityRules": { @@ -1602,8 +1565,7 @@ "$ref": "GoogleCloudDataplexV1GenerateDataQualityRulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -1643,8 +1605,7 @@ "$ref": "GoogleCloudDataplexV1DataScan" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { @@ -1675,8 +1636,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -1722,8 +1682,7 @@ "$ref": "GoogleCloudDataplexV1ListDataScansResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -1762,8 +1721,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "run": { @@ -1791,8 +1749,7 @@ "$ref": "GoogleCloudDataplexV1RunDataScanResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -1820,8 +1777,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -1849,8 +1805,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } }, @@ -1882,8 +1837,7 @@ "$ref": "GoogleCloudDataplexV1GenerateDataQualityRulesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -1923,8 +1877,7 @@ "$ref": "GoogleCloudDataplexV1DataScanJob" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -1965,8 +1918,7 @@ "$ref": "GoogleCloudDataplexV1ListDataScanJobsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -2010,8 +1962,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -2042,8 +1993,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -2068,8 +2018,7 @@ "$ref": "GoogleCloudDataplexV1DataTaxonomy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { @@ -2100,8 +2049,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -2148,8 +2096,7 @@ "$ref": "GoogleCloudDataplexV1ListDataTaxonomiesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -2189,8 +2136,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -2218,8 +2164,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -2247,8 +2192,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } }, @@ -2291,8 +2235,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -2323,8 +2266,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -2350,8 +2292,7 @@ "$ref": "GoogleCloudDataplexV1DataAttribute" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { @@ -2382,8 +2323,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -2430,8 +2370,7 @@ "$ref": "GoogleCloudDataplexV1ListDataAttributesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -2471,8 +2410,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -2500,8 +2438,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -2529,8 +2466,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -2574,8 +2510,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -2605,8 +2540,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -2631,8 +2565,7 @@ "$ref": "GoogleCloudDataplexV1EntryGroup" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { @@ -2663,8 +2596,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -2710,8 +2642,7 @@ "$ref": "GoogleCloudDataplexV1ListEntryGroupsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -2750,8 +2681,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -2779,8 +2709,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -2808,8 +2737,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } }, @@ -2846,8 +2774,7 @@ "$ref": "GoogleCloudDataplexV1Entry" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -2872,8 +2799,7 @@ "$ref": "GoogleCloudDataplexV1Entry" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -2929,8 +2855,7 @@ "$ref": "GoogleCloudDataplexV1Entry" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -2971,8 +2896,7 @@ "$ref": "GoogleCloudDataplexV1ListEntriesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -3022,8 +2946,7 @@ "$ref": "GoogleCloudDataplexV1Entry" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -3060,8 +2983,7 @@ "$ref": "GoogleCloudDataplexV1EntryLink" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -3086,8 +3008,7 @@ "$ref": "GoogleCloudDataplexV1EntryLink" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -3112,8 +3033,7 @@ "$ref": "GoogleCloudDataplexV1EntryLink" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -3150,8 +3070,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -3179,8 +3098,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -3208,8 +3126,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -3251,8 +3168,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -3282,8 +3198,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -3308,8 +3223,7 @@ "$ref": "GoogleCloudDataplexV1EntryType" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { @@ -3340,8 +3254,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -3387,8 +3300,7 @@ "$ref": "GoogleCloudDataplexV1ListEntryTypesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -3427,8 +3339,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -3456,8 +3367,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -3485,8 +3395,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -3528,8 +3437,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -3559,8 +3467,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -3585,8 +3492,7 @@ "$ref": "GoogleCloudDataplexV1Glossary" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { @@ -3617,8 +3523,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -3664,8 +3569,7 @@ "$ref": "GoogleCloudDataplexV1ListGlossariesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -3704,8 +3608,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -3733,8 +3636,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -3762,8 +3664,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } }, @@ -3800,8 +3701,7 @@ "$ref": "GoogleCloudDataplexV1GlossaryCategory" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -3826,8 +3726,7 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -3852,8 +3751,7 @@ "$ref": "GoogleCloudDataplexV1GlossaryCategory" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { @@ -3884,8 +3782,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -3931,8 +3828,7 @@ "$ref": "GoogleCloudDataplexV1ListGlossaryCategoriesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -3966,8 +3862,7 @@ "$ref": "GoogleCloudDataplexV1GlossaryCategory" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -3995,8 +3890,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -4024,8 +3918,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -4062,8 +3955,7 @@ "$ref": "GoogleCloudDataplexV1GlossaryTerm" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -4088,8 +3980,7 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -4114,8 +4005,7 @@ "$ref": "GoogleCloudDataplexV1GlossaryTerm" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { @@ -4146,8 +4036,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -4193,8 +4082,7 @@ "$ref": "GoogleCloudDataplexV1ListGlossaryTermsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -4228,8 +4116,7 @@ "$ref": "GoogleCloudDataplexV1GlossaryTerm" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -4257,8 +4144,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -4286,8 +4172,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -4324,8 +4209,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -4353,8 +4237,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -4382,8 +4265,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -4425,8 +4307,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -4451,8 +4332,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -4477,8 +4357,7 @@ "$ref": "GoogleCloudDataplexV1Lake" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { @@ -4509,8 +4388,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -4556,8 +4434,7 @@ "$ref": "GoogleCloudDataplexV1ListLakesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -4596,8 +4473,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -4625,8 +4501,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -4654,8 +4529,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } }, @@ -4695,8 +4569,7 @@ "$ref": "GoogleCloudDataplexV1ListActionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -4733,8 +4606,7 @@ "$ref": "GoogleCloudDataplexV1Content" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -4759,8 +4631,7 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -4800,8 +4671,7 @@ "$ref": "GoogleCloudDataplexV1Content" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { @@ -4832,8 +4702,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -4874,8 +4743,7 @@ "$ref": "GoogleCloudDataplexV1ListContentResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -4914,8 +4782,7 @@ "$ref": "GoogleCloudDataplexV1Content" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -4943,8 +4810,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -4972,8 +4838,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -5010,8 +4875,7 @@ "$ref": "GoogleCloudDataplexV1Content" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -5036,8 +4900,7 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -5077,8 +4940,7 @@ "$ref": "GoogleCloudDataplexV1Content" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { @@ -5109,8 +4971,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -5151,8 +5012,7 @@ "$ref": "GoogleCloudDataplexV1ListContentResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -5191,8 +5051,7 @@ "$ref": "GoogleCloudDataplexV1Content" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -5220,8 +5079,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -5249,8 +5107,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -5292,8 +5149,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -5318,8 +5174,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -5344,8 +5199,7 @@ "$ref": "GoogleCloudDataplexV1Environment" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { @@ -5376,8 +5230,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -5423,8 +5276,7 @@ "$ref": "GoogleCloudDataplexV1ListEnvironmentsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -5463,8 +5315,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -5492,8 +5343,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -5521,8 +5371,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } }, @@ -5567,8 +5416,7 @@ "$ref": "GoogleCloudDataplexV1ListSessionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -5612,8 +5460,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -5638,8 +5485,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -5664,8 +5510,7 @@ "$ref": "GoogleCloudDataplexV1Task" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { @@ -5696,8 +5541,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -5743,8 +5587,7 @@ "$ref": "GoogleCloudDataplexV1ListTasksResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -5783,8 +5626,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "run": { @@ -5812,8 +5654,7 @@ "$ref": "GoogleCloudDataplexV1RunTaskResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -5841,8 +5682,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -5870,8 +5710,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } }, @@ -5903,8 +5742,7 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -5929,8 +5767,7 @@ "$ref": "GoogleCloudDataplexV1Job" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -5966,8 +5803,7 @@ "$ref": "GoogleCloudDataplexV1ListJobsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -6011,8 +5847,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -6037,8 +5872,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -6063,8 +5897,7 @@ "$ref": "GoogleCloudDataplexV1Zone" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { @@ -6095,8 +5928,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -6142,8 +5974,7 @@ "$ref": "GoogleCloudDataplexV1ListZonesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -6182,8 +6013,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -6211,8 +6041,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -6240,8 +6069,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } }, @@ -6281,8 +6109,7 @@ "$ref": "GoogleCloudDataplexV1ListActionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -6324,8 +6151,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -6350,8 +6176,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -6376,8 +6201,7 @@ "$ref": "GoogleCloudDataplexV1Asset" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "getIamPolicy": { @@ -6408,8 +6232,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -6455,8 +6278,7 @@ "$ref": "GoogleCloudDataplexV1ListAssetsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -6495,8 +6317,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "setIamPolicy": { @@ -6524,8 +6345,7 @@ "$ref": "GoogleIamV1Policy" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "testIamPermissions": { @@ -6553,8 +6373,7 @@ "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } }, @@ -6594,8 +6413,7 @@ "$ref": "GoogleCloudDataplexV1ListActionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -6634,8 +6452,7 @@ "$ref": "GoogleCloudDataplexV1Entity" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -6665,8 +6482,7 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -6708,8 +6524,7 @@ "$ref": "GoogleCloudDataplexV1Entity" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -6765,8 +6580,7 @@ "$ref": "GoogleCloudDataplexV1ListEntitiesResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "update": { @@ -6799,8 +6613,7 @@ "$ref": "GoogleCloudDataplexV1Entity" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } }, @@ -6837,8 +6650,7 @@ "$ref": "GoogleCloudDataplexV1Partition" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -6869,8 +6681,7 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -6895,8 +6706,7 @@ "$ref": "GoogleCloudDataplexV1Partition" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -6937,8 +6747,7 @@ "$ref": "GoogleCloudDataplexV1ListPartitionsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -6976,8 +6785,7 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "create": { @@ -7015,8 +6823,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -7041,8 +6848,7 @@ "$ref": "GoogleCloudDataplexV1MetadataJob" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -7088,8 +6894,7 @@ "$ref": "GoogleCloudDataplexV1ListMetadataJobsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -7121,8 +6926,7 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { @@ -7147,8 +6951,7 @@ "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -7173,8 +6976,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -7215,8 +7017,7 @@ "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only" +"https://www.googleapis.com/auth/cloud-platform" ] } } @@ -7226,7 +7027,7 @@ } } }, -"revision": "20250708", +"revision": "20250714", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -10728,7 +10529,7 @@ "type": "string" }, "entryLinkType": { -"description": "Required. Immutable. Relative resource name of the Entry Link Type used to create this Entry Link, of the form: `projects/{project_id_or_number}/locations/{location_id}/entryLinkTypes/{entry_link_type_id}.", +"description": "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", "type": "string" }, "entryReferences": { diff --git a/googleapiclient/discovery_cache/documents/dataportability.v1.json b/googleapiclient/discovery_cache/documents/dataportability.v1.json index 09606c63e53..8808a2bbe10 100644 --- a/googleapiclient/discovery_cache/documents/dataportability.v1.json +++ b/googleapiclient/discovery_cache/documents/dataportability.v1.json @@ -5,9 +5,6 @@ "https://www.googleapis.com/auth/dataportability.alerts.subscriptions": { "description": "Move a copy of the Google Alerts subscriptions you created" }, -"https://www.googleapis.com/auth/dataportability.businessmessaging.conversations": { -"description": "Move a copy of messages between you and the businesses you have conversations with across Google services" -}, "https://www.googleapis.com/auth/dataportability.chrome.autofill": { "description": "Move a copy of the information you entered into online forms in Chrome" }, @@ -321,7 +318,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", -"https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", "https://www.googleapis.com/auth/dataportability.chrome.dictionary", @@ -419,7 +415,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", -"https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", "https://www.googleapis.com/auth/dataportability.chrome.dictionary", @@ -510,7 +505,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", -"https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", "https://www.googleapis.com/auth/dataportability.chrome.dictionary", @@ -604,7 +598,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", -"https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", "https://www.googleapis.com/auth/dataportability.chrome.dictionary", @@ -692,7 +685,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", -"https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", "https://www.googleapis.com/auth/dataportability.chrome.dictionary", @@ -780,7 +772,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", -"https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", "https://www.googleapis.com/auth/dataportability.chrome.dictionary", @@ -851,7 +842,7 @@ } } }, -"revision": "20250605", +"revision": "20250715", "rootUrl": "https://dataportability.googleapis.com/", "schemas": { "CancelPortabilityArchiveRequest": { diff --git a/googleapiclient/discovery_cache/documents/dataportability.v1beta.json b/googleapiclient/discovery_cache/documents/dataportability.v1beta.json index ec45f42b0b2..a49c2ffb319 100644 --- a/googleapiclient/discovery_cache/documents/dataportability.v1beta.json +++ b/googleapiclient/discovery_cache/documents/dataportability.v1beta.json @@ -5,9 +5,6 @@ "https://www.googleapis.com/auth/dataportability.alerts.subscriptions": { "description": "Move a copy of the Google Alerts subscriptions you created" }, -"https://www.googleapis.com/auth/dataportability.businessmessaging.conversations": { -"description": "Move a copy of messages between you and the businesses you have conversations with across Google services" -}, "https://www.googleapis.com/auth/dataportability.chrome.autofill": { "description": "Move a copy of the information you entered into online forms in Chrome" }, @@ -321,7 +318,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", -"https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", "https://www.googleapis.com/auth/dataportability.chrome.dictionary", @@ -419,7 +415,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", -"https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", "https://www.googleapis.com/auth/dataportability.chrome.dictionary", @@ -510,7 +505,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", -"https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", "https://www.googleapis.com/auth/dataportability.chrome.dictionary", @@ -604,7 +598,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", -"https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", "https://www.googleapis.com/auth/dataportability.chrome.dictionary", @@ -692,7 +685,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", -"https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", "https://www.googleapis.com/auth/dataportability.chrome.dictionary", @@ -780,7 +772,6 @@ }, "scopes": [ "https://www.googleapis.com/auth/dataportability.alerts.subscriptions", -"https://www.googleapis.com/auth/dataportability.businessmessaging.conversations", "https://www.googleapis.com/auth/dataportability.chrome.autofill", "https://www.googleapis.com/auth/dataportability.chrome.bookmarks", "https://www.googleapis.com/auth/dataportability.chrome.dictionary", @@ -851,7 +842,7 @@ } } }, -"revision": "20250605", +"revision": "20250715", "rootUrl": "https://dataportability.googleapis.com/", "schemas": { "CancelPortabilityArchiveRequest": { diff --git a/googleapiclient/discovery_cache/documents/datastream.v1.json b/googleapiclient/discovery_cache/documents/datastream.v1.json index 33857c72626..04b024db4a0 100644 --- a/googleapiclient/discovery_cache/documents/datastream.v1.json +++ b/googleapiclient/discovery_cache/documents/datastream.v1.json @@ -1261,7 +1261,7 @@ } } }, -"revision": "20250627", +"revision": "20250714", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AppendOnly": { @@ -2912,6 +2912,10 @@ "description": "Output only. Indicates whether the ca_certificate field has been set for this Connection-Profile.", "readOnly": true, "type": "boolean" +}, +"serverCertificateDistinguishedName": { +"description": "Optional. The distinguished name (DN) mentioned in the server certificate. This corresponds to SSL_SERVER_CERT_DN sqlnet parameter. Refer https://docs.oracle.com/en/database/oracle/oracle-database/19/netrf/local-naming-parameters-in-tns-ora-file.html#GUID-70AB0695-A9AA-4A94-B141-4C605236EEB7 If this field is not provided, the DN matching is not enforced.", +"type": "string" } }, "type": "object" @@ -3397,6 +3401,10 @@ "clientKey": { "description": "Optional. Input only. PEM-encoded private key associated with the client certificate. This value will be used during the SSL/TLS handshake, allowing the PostgreSQL server to authenticate the client's identity, i.e. identity of the Datastream.", "type": "string" +}, +"serverCertificateHostname": { +"description": "Optional. The hostname mentioned in the Subject or SAN extension of the server certificate. If this field is not provided, the hostname in the server certificate is not validated.", +"type": "string" } }, "type": "object" @@ -3408,6 +3416,10 @@ "caCertificate": { "description": "Required. Input only. PEM-encoded server root CA certificate.", "type": "string" +}, +"serverCertificateHostname": { +"description": "Optional. The hostname mentioned in the Subject or SAN extension of the server certificate. If this field is not provided, the hostname in the server certificate is not validated.", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/developerconnect.v1.json b/googleapiclient/discovery_cache/documents/developerconnect.v1.json index 579dbd6522e..fd9eccf17df 100644 --- a/googleapiclient/discovery_cache/documents/developerconnect.v1.json +++ b/googleapiclient/discovery_cache/documents/developerconnect.v1.json @@ -1601,7 +1601,7 @@ } } }, -"revision": "20250530", +"revision": "20250710", "rootUrl": "https://developerconnect.googleapis.com/", "schemas": { "AccountConnector": { @@ -1686,7 +1686,7 @@ }, "googleArtifactRegistry": { "$ref": "GoogleArtifactRegistry", -"description": "Optional. Set if the artifact is stored in Artifact regsitry." +"description": "Optional. Set if the artifact is stored in Artifact registry." }, "uri": { "description": "Required. Immutable. The URI of the artifact that is deployed. e.g. `us-docker.pkg.dev/my-project/my-repo/image`. The URI does not include the tag / digest because it captures a lineage of artifacts.", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json index 05cfdcfd317..6fb831b8dca 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json @@ -8545,6 +8545,163 @@ } } }, +"sipTrunks": { +"methods": { +"create": { +"description": "Creates a SipTrunk for a specified location.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/sipTrunks", +"httpMethod": "POST", +"id": "dialogflow.projects.locations.sipTrunks.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The location to create a SIP trunk for. Format: `projects//locations/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}/sipTrunks", +"request": { +"$ref": "GoogleCloudDialogflowV2SipTrunk" +}, +"response": { +"$ref": "GoogleCloudDialogflowV2SipTrunk" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"delete": { +"description": "Deletes a specified SipTrunk.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/sipTrunks/{sipTrunksId}", +"httpMethod": "DELETE", +"id": "dialogflow.projects.locations.sipTrunks.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the SIP trunk to delete. Format: `projects//locations//sipTrunks/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sipTrunks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"get": { +"description": "Retrieves the specified SipTrunk.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/sipTrunks/{sipTrunksId}", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.sipTrunks.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the SIP trunk to delete. Format: `projects//locations//sipTrunks/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sipTrunks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "GoogleCloudDialogflowV2SipTrunk" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"list": { +"description": "Returns a list of SipTrunks in the specified location.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/sipTrunks", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.sipTrunks.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value returned from a previous list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The location to list SIP trunks from. Format: `projects//locations/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}/sipTrunks", +"response": { +"$ref": "GoogleCloudDialogflowV2ListSipTrunksResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"patch": { +"description": "Updates the specified SipTrunk.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/sipTrunks/{sipTrunksId}", +"httpMethod": "PATCH", +"id": "dialogflow.projects.locations.sipTrunks.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The unique identifier of the SIP trunk. Format: `projects//locations//sipTrunks/`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sipTrunks/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v2/{+name}", +"request": { +"$ref": "GoogleCloudDialogflowV2SipTrunk" +}, +"response": { +"$ref": "GoogleCloudDialogflowV2SipTrunk" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +} +} +}, "statelessSuggestion": { "methods": { "generate": { @@ -8805,7 +8962,7 @@ } } }, -"revision": "20250627", +"revision": "20250715", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -14520,6 +14677,86 @@ true "properties": {}, "type": "object" }, +"GoogleCloudDialogflowV2Connection": { +"description": "Represents a connection for SIP Trunk.", +"id": "GoogleCloudDialogflowV2Connection", +"properties": { +"connectionId": { +"description": "Output only. The unique identifier of the SIP Trunk connection.", +"readOnly": true, +"type": "string" +}, +"errorDetails": { +"$ref": "GoogleCloudDialogflowV2ConnectionErrorDetails", +"description": "Output only. The error details for the connection. Only populated when authentication errors occur.", +"readOnly": true +}, +"state": { +"description": "Output only. State of the connection.", +"enum": [ +"STATE_UNSPECIFIED", +"CONNECTED", +"DISCONNECTED", +"AUTHENTICATION_FAILED", +"KEEPALIVE" +], +"enumDescriptions": [ +"SIP Trunk connection state is Not specified.", +"SIP Trunk connection is connected.", +"SIP Trunk connection is disconnected.", +"SIP Trunk connection has authentication error.", +"SIP Trunk connection is keepalive." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. When the connection status changed.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2ConnectionErrorDetails": { +"description": "The error details of Sip Trunk connection authentication.", +"id": "GoogleCloudDialogflowV2ConnectionErrorDetails", +"properties": { +"certificateState": { +"description": "Output only. The status of the certificate authentication.", +"enum": [ +"CERTIFICATE_STATE_UNSPECIFIED", +"CERTIFICATE_VALID", +"CERTIFICATE_INVALID", +"CERTIFICATE_EXPIRED", +"CERTIFICATE_HOSTNAME_NOT_FOUND", +"CERTIFICATE_UNAUTHENTICATED", +"CERTIFICATE_TRUST_STORE_NOT_FOUND", +"CERTIFICATE_HOSTNAME_INVALID_FORMAT", +"CERTIFICATE_QUOTA_EXCEEDED" +], +"enumDescriptions": [ +"Certificate state is not specified.", +"Certificate is valid.", +"Catch all for any error not specified.", +"Certificate leaf node has expired.", +"There is no hostname defined to authenticate in SipTrunkingServer.", +"No path found from the leaf certificate to any root.", +"Trust store does not exist.", +"Hostname has invalid format.", +"Certificate has exhausted its quota." +], +"readOnly": true, +"type": "string" +}, +"errorMessage": { +"description": "The error message provided from SIP trunking auth service", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2Context": { "description": "Dialogflow contexts are similar to natural language context. If a person says to you \"they are orange\", you need context in order to understand what \"they\" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview).", "id": "GoogleCloudDialogflowV2Context", @@ -18401,6 +18638,24 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2ListSipTrunksResponse": { +"description": "The response message for SipTrunks.ListSipTrunks.", +"id": "GoogleCloudDialogflowV2ListSipTrunksResponse", +"properties": { +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", +"type": "string" +}, +"sipTrunks": { +"description": "The list of SIP trunks.", +"items": { +"$ref": "GoogleCloudDialogflowV2SipTrunk" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2ListVersionsResponse": { "description": "The response message for Versions.ListVersions.", "id": "GoogleCloudDialogflowV2ListVersionsResponse", @@ -19359,6 +19614,36 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2SipTrunk": { +"description": "SipTrunk is the resource that represents a SIP trunk to connect to Google Telephony platform SIP trunking service.", +"id": "GoogleCloudDialogflowV2SipTrunk", +"properties": { +"connections": { +"description": "Output only. Connections of the SIP trunk.", +"items": { +"$ref": "GoogleCloudDialogflowV2Connection" +}, +"readOnly": true, +"type": "array" +}, +"displayName": { +"description": "Optional. Human readable alias for this trunk.", +"type": "string" +}, +"expectedHostname": { +"description": "Required. The expected hostnames in the peer certificate from partner that is used for TLS authentication.", +"items": { +"type": "string" +}, +"type": "array" +}, +"name": { +"description": "Identifier. The unique identifier of the SIP trunk. Format: `projects//locations//sipTrunks/`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2SmartReplyAnswer": { "description": "Represents a smart reply answer.", "id": "GoogleCloudDialogflowV2SmartReplyAnswer", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index 1410b5b0dd3..36cd0fdfb3a 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -4,6 +4,9 @@ "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +}, +"https://www.googleapis.com/auth/cloud_search.query": { +"description": "Search your organization's data in the Cloud Search index" } } } @@ -35,6 +38,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://discoveryengine.eu.rep.googleapis.com/", "location": "eu" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://discoveryengine.in.rep.googleapis.com/", +"location": "in" } ], "fullyEncodeReservedExpansion": true, @@ -1048,6 +1056,39 @@ } } }, +"completionConfig": { +"methods": { +"completeQuery": { +"description": "Completes the user input with advanced keyword suggestions.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/completionConfig:completeQuery", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.dataStores.completionConfig.completeQuery", +"parameterOrder": [ +"completionConfig" +], +"parameters": { +"completionConfig": { +"description": "Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/completionConfig$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+completionConfig}:completeQuery", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud_search.query" +] +} +} +}, "completionSuggestions": { "methods": { "import": { @@ -3153,6 +3194,71 @@ } }, "resources": { +"assistants": { +"methods": { +"streamAssist": { +"description": "Assists the user with a query in a streaming fashion.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}:streamAssist", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.engines.assistants.streamAssist", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:streamAssist", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1StreamAssistResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"completionConfig": { +"methods": { +"completeQuery": { +"description": "Completes the user input with advanced keyword suggestions.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/completionConfig:completeQuery", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.engines.completionConfig.completeQuery", +"parameterOrder": [ +"completionConfig" +], +"parameters": { +"completionConfig": { +"description": "Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+completionConfig}:completeQuery", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud_search.query" +] +} +} +}, "controls": { "methods": { "create": { @@ -4664,6 +4770,39 @@ } } }, +"completionConfig": { +"methods": { +"completeQuery": { +"description": "Completes the user input with advanced keyword suggestions.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionConfig:completeQuery", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.completionConfig.completeQuery", +"parameterOrder": [ +"completionConfig" +], +"parameters": { +"completionConfig": { +"description": "Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig` `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/completionConfig$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+completionConfig}:completeQuery", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud_search.query" +] +} +} +}, "completionSuggestions": { "methods": { "import": { @@ -7052,7 +7191,7 @@ } } }, -"revision": "20250706", +"revision": "20250716", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -7468,6 +7607,318 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest": { +"description": "Request message for CompletionService.AdvancedCompleteQuery method. .", +"id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest", +"properties": { +"boostSpec": { +"$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec", +"description": "Optional. Specification to boost suggestions matching the condition." +}, +"experimentIds": { +"description": "Optional. Experiment ids for this request.", +"items": { +"type": "string" +}, +"type": "array" +}, +"includeTailSuggestions": { +"description": "Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.", +"type": "boolean" +}, +"query": { +"description": "Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called \"zero prefix\" feature, which returns user's recently searched queries given the empty query.", +"type": "string" +}, +"queryModel": { +"description": "Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.", +"type": "string" +}, +"suggestionTypeSpecs": { +"description": "Optional. Specification of each suggestion type.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec" +}, +"type": "array" +}, +"suggestionTypes": { +"description": "Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.", +"items": { +"enum": [ +"SUGGESTION_TYPE_UNSPECIFIED", +"QUERY", +"PEOPLE", +"CONTENT", +"RECENT_SEARCH", +"GOOGLE_WORKSPACE" +], +"enumDescriptions": [ +"Default value.", +"Returns query suggestions.", +"Returns people suggestions.", +"Returns content suggestions.", +"Returns recent search suggestions.", +"Returns Google Workspace suggestions." +], +"type": "string" +}, +"type": "array" +}, +"userInfo": { +"$ref": "GoogleCloudDiscoveryengineV1UserInfo", +"description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info." +}, +"userPseudoId": { +"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec": { +"description": "Specification to boost suggestions based on the condtion of the suggestion.", +"id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec", +"properties": { +"conditionBoostSpecs": { +"description": "Condition boost specifications. If a suggestion matches multiple conditions in the specifications, boost values from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. Note: Currently only support language condition boost.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec": { +"description": "Boost applies to suggestions which match a condition.", +"id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpecConditionBoostSpec", +"properties": { +"boost": { +"description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored.", +"format": "float", +"type": "number" +}, +"condition": { +"description": "An expression which specifies a boost condition. The syntax is the same as [filter expression syntax](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax). Currently, the only supported condition is a list of BCP-47 lang codes. Example: * To boost suggestions in languages `en` or `fr`: `(lang_code: ANY(\"en\", \"fr\"))`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec": { +"description": "Specification of each suggestion type.", +"id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestSuggestionTypeSpec", +"properties": { +"maxSuggestions": { +"description": "Optional. Maximum number of suggestions to return for each suggestion type.", +"format": "int32", +"type": "integer" +}, +"suggestionType": { +"description": "Optional. Suggestion type.", +"enum": [ +"SUGGESTION_TYPE_UNSPECIFIED", +"QUERY", +"PEOPLE", +"CONTENT", +"RECENT_SEARCH", +"GOOGLE_WORKSPACE" +], +"enumDescriptions": [ +"Default value.", +"Returns query suggestions.", +"Returns people suggestions.", +"Returns content suggestions.", +"Returns recent search suggestions.", +"Returns Google Workspace suggestions." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse": { +"description": "Response message for CompletionService.AdvancedCompleteQuery method.", +"id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponse", +"properties": { +"contentSuggestions": { +"description": "Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion" +}, +"type": "array" +}, +"peopleSuggestions": { +"description": "Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion" +}, +"type": "array" +}, +"querySuggestions": { +"description": "Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion" +}, +"type": "array" +}, +"recentSearchSuggestions": { +"description": "Results of the matched \"recent search\" suggestions. The result list is ordered and the first result is the top suggestion.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion" +}, +"type": "array" +}, +"tailMatchTriggered": { +"description": "True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion": { +"description": "Suggestions as content.", +"id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseContentSuggestion", +"properties": { +"contentType": { +"description": "The type of the content suggestion.", +"enum": [ +"CONTENT_TYPE_UNSPECIFIED", +"GOOGLE_WORKSPACE", +"THIRD_PARTY" +], +"enumDescriptions": [ +"Default value.", +"The suggestion is from a Google Workspace source.", +"The suggestion is from a third party source." +], +"type": "string" +}, +"dataStore": { +"description": "The name of the dataStore that this suggestion belongs to.", +"type": "string" +}, +"destinationUri": { +"description": "The destination uri of the content suggestion.", +"type": "string" +}, +"document": { +"$ref": "GoogleCloudDiscoveryengineV1Document", +"description": "The document data snippet in the suggestion. Only a subset of fields will be populated." +}, +"iconUri": { +"description": "The icon uri of the content suggestion.", +"type": "string" +}, +"score": { +"description": "The score of each suggestion. The score is in the range of [0, 1].", +"format": "double", +"type": "number" +}, +"suggestion": { +"description": "The suggestion for the query.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion": { +"description": "Suggestions as people.", +"id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponsePersonSuggestion", +"properties": { +"dataStore": { +"description": "The name of the dataStore that this suggestion belongs to.", +"type": "string" +}, +"destinationUri": { +"description": "The destination uri of the person suggestion.", +"type": "string" +}, +"displayPhotoUri": { +"description": "The photo uri of the person suggestion.", +"type": "string" +}, +"document": { +"$ref": "GoogleCloudDiscoveryengineV1Document", +"description": "The document data snippet in the suggestion. Only a subset of fields is populated." +}, +"personType": { +"description": "The type of the person.", +"enum": [ +"PERSON_TYPE_UNSPECIFIED", +"CLOUD_IDENTITY", +"THIRD_PARTY_IDENTITY" +], +"enumDescriptions": [ +"Default value.", +"The suggestion is from a GOOGLE_IDENTITY source.", +"The suggestion is from a THIRD_PARTY_IDENTITY source." +], +"type": "string" +}, +"score": { +"description": "The score of each suggestion. The score is in the range of [0, 1].", +"format": "double", +"type": "number" +}, +"suggestion": { +"description": "The suggestion for the query.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion": { +"description": "Suggestions as search queries.", +"id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseQuerySuggestion", +"properties": { +"completableFieldPaths": { +"description": "The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model.", +"items": { +"type": "string" +}, +"type": "array" +}, +"dataStore": { +"description": "The name of the dataStore that this suggestion belongs to.", +"items": { +"type": "string" +}, +"type": "array" +}, +"score": { +"description": "The score of each suggestion. The score is in the range of [0, 1].", +"format": "double", +"type": "number" +}, +"suggestion": { +"description": "The suggestion for the query.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion": { +"description": "Suggestions from recent search history.", +"id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryResponseRecentSearchSuggestion", +"properties": { +"recentSearchTime": { +"description": "The time when this recent rearch happened.", +"format": "google-datetime", +"type": "string" +}, +"score": { +"description": "The score of each suggestion. The score is in the range of [0, 1].", +"format": "double", +"type": "number" +}, +"suggestion": { +"description": "The suggestion for the query.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig": { "description": "Configuration data for advance site search.", "id": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig", @@ -8525,188 +8976,479 @@ "description": "Properties of the object.", "type": "any" }, -"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", +"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", +"type": "object" +}, +"title": { +"description": "Title.", +"type": "string" +}, +"uri": { +"description": "URI for the document.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent": { +"description": "Chunk content.", +"id": "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent", +"properties": { +"content": { +"description": "Chunk textual content.", +"type": "string" +}, +"pageIdentifier": { +"description": "Page identifier.", +"type": "string" +}, +"relevanceScore": { +"description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AnswerStep": { +"description": "Step information.", +"id": "GoogleCloudDiscoveryengineV1AnswerStep", +"properties": { +"actions": { +"description": "Actions.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1AnswerStepAction" +}, +"type": "array" +}, +"description": { +"description": "The description of the step.", +"type": "string" +}, +"state": { +"description": "The state of the step.", +"enum": [ +"STATE_UNSPECIFIED", +"IN_PROGRESS", +"FAILED", +"SUCCEEDED" +], +"enumDescriptions": [ +"Unknown.", +"Step is currently in progress.", +"Step currently failed.", +"Step has succeeded." +], +"type": "string" +}, +"thought": { +"description": "The thought of the step.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AnswerStepAction": { +"description": "Action.", +"id": "GoogleCloudDiscoveryengineV1AnswerStepAction", +"properties": { +"observation": { +"$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservation", +"description": "Observation." +}, +"searchAction": { +"$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction", +"description": "Search action." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AnswerStepActionObservation": { +"description": "Observation.", +"id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservation", +"properties": { +"searchResults": { +"description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult": { +"id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult", +"properties": { +"chunkInfo": { +"description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo" +}, +"type": "array" +}, +"document": { +"description": "Document resource name.", +"type": "string" +}, +"snippetInfo": { +"description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo" +}, +"type": "array" +}, +"structData": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.", +"type": "object" +}, +"title": { +"description": "Title.", +"type": "string" +}, +"uri": { +"description": "URI for the document.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo": { +"description": "Chunk information.", +"id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo", +"properties": { +"chunk": { +"description": "Chunk resource name.", +"type": "string" +}, +"content": { +"description": "Chunk textual content.", +"type": "string" +}, +"relevanceScore": { +"description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo": { +"description": "Snippet information.", +"id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo", +"properties": { +"snippet": { +"description": "Snippet content.", +"type": "string" +}, +"snippetStatus": { +"description": "Status of the snippet defined by the search team.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction": { +"description": "Search action.", +"id": "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction", +"properties": { +"query": { +"description": "The query to search.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AssistAnswer": { +"description": "AssistAnswer resource, main part of AssistResponse.", +"id": "GoogleCloudDiscoveryengineV1AssistAnswer", +"properties": { +"assistSkippedReasons": { +"description": "Reasons for not answering the assist call.", +"items": { +"enum": [ +"ASSIST_SKIPPED_REASON_UNSPECIFIED", +"NON_ASSIST_SEEKING_QUERY_IGNORED", +"CUSTOMER_POLICY_VIOLATION" +], +"enumDescriptions": [ +"Default value. Skip reason is not specified.", +"The assistant ignored the query, because it did not appear to be answer-seeking.", +"The assistant ignored the query or refused to answer because of a customer policy violation (e.g., the query or the answer contained a banned phrase)." +], +"type": "string" +}, +"type": "array" +}, +"replies": { +"description": "Replies of the assistant.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1AssistAnswerReply" +}, +"type": "array" +}, +"state": { +"description": "State of the answer generation.", +"enum": [ +"STATE_UNSPECIFIED", +"IN_PROGRESS", +"FAILED", +"SUCCEEDED", +"SKIPPED" +], +"enumDescriptions": [ +"Unknown.", +"Assist operation is currently in progress.", +"Assist operation has failed.", +"Assist operation has succeeded.", +"Assist operation has been skipped." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AssistAnswerReply": { +"description": "One part of the multi-part response of the assist call.", +"id": "GoogleCloudDiscoveryengineV1AssistAnswerReply", +"properties": { +"groundedContent": { +"$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContent", +"description": "Possibly grounded response text or media from the assistant." +} +}, "type": "object" }, -"title": { -"description": "Title.", +"GoogleCloudDiscoveryengineV1AssistUserMetadata": { +"description": "User metadata of the request.", +"id": "GoogleCloudDiscoveryengineV1AssistUserMetadata", +"properties": { +"preferredLanguageCode": { +"description": "Optional. Preferred language to be used for answering if language detection fails. Also used as the language of error messages created by actions, regardless of language detection results.", "type": "string" }, -"uri": { -"description": "URI for the document.", +"timeZone": { +"description": "Optional. IANA time zone, e.g. Europe/Budapest.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent": { -"description": "Chunk content.", -"id": "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent", +"GoogleCloudDiscoveryengineV1AssistantContent": { +"description": "Multi-modal content.", +"id": "GoogleCloudDiscoveryengineV1AssistantContent", "properties": { -"content": { -"description": "Chunk textual content.", +"codeExecutionResult": { +"$ref": "GoogleCloudDiscoveryengineV1AssistantContentCodeExecutionResult", +"description": "Result of executing an ExecutableCode." +}, +"executableCode": { +"$ref": "GoogleCloudDiscoveryengineV1AssistantContentExecutableCode", +"description": "Code generated by the model that is meant to be executed." +}, +"file": { +"$ref": "GoogleCloudDiscoveryengineV1AssistantContentFile", +"description": "A file, e.g., an audio summary." +}, +"inlineData": { +"$ref": "GoogleCloudDiscoveryengineV1AssistantContentBlob", +"description": "Inline binary data." +}, +"role": { +"description": "The producer of the content. Can be \"model\" or \"user\".", "type": "string" }, -"pageIdentifier": { -"description": "Page identifier.", +"text": { +"description": "Inline text.", "type": "string" }, -"relevanceScore": { -"description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", -"format": "float", -"type": "number" +"thought": { +"description": "Optional. Indicates if the part is thought from the model.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1AnswerStep": { -"description": "Step information.", -"id": "GoogleCloudDiscoveryengineV1AnswerStep", +"GoogleCloudDiscoveryengineV1AssistantContentBlob": { +"description": "Inline blob.", +"id": "GoogleCloudDiscoveryengineV1AssistantContentBlob", "properties": { -"actions": { -"description": "Actions.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1AnswerStepAction" -}, -"type": "array" +"data": { +"description": "Required. Raw bytes.", +"format": "byte", +"type": "string" }, -"description": { -"description": "The description of the step.", +"mimeType": { +"description": "Required. The media type (MIME type) of the generated data.", "type": "string" +} }, -"state": { -"description": "The state of the step.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AssistantContentCodeExecutionResult": { +"description": "Result of executing ExecutableCode.", +"id": "GoogleCloudDiscoveryengineV1AssistantContentCodeExecutionResult", +"properties": { +"outcome": { +"description": "Required. Outcome of the code execution.", "enum": [ -"STATE_UNSPECIFIED", -"IN_PROGRESS", -"FAILED", -"SUCCEEDED" +"OUTCOME_UNSPECIFIED", +"OUTCOME_OK", +"OUTCOME_FAILED", +"OUTCOME_DEADLINE_EXCEEDED" ], "enumDescriptions": [ -"Unknown.", -"Step is currently in progress.", -"Step currently failed.", -"Step has succeeded." +"Unspecified status. This value should not be used.", +"Code execution completed successfully.", +"Code execution finished but with a failure. `stderr` should contain the reason.", +"Code execution ran for too long, and was cancelled. There may or may not be a partial output present." ], "type": "string" }, -"thought": { -"description": "The thought of the step.", +"output": { +"description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1AnswerStepAction": { -"description": "Action.", -"id": "GoogleCloudDiscoveryengineV1AnswerStepAction", +"GoogleCloudDiscoveryengineV1AssistantContentExecutableCode": { +"description": "Code generated by the model that is meant to be executed by the model.", +"id": "GoogleCloudDiscoveryengineV1AssistantContentExecutableCode", "properties": { -"observation": { -"$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservation", -"description": "Observation." +"code": { +"description": "Required. The code content. Currently only supports Python.", +"type": "string" +} }, -"searchAction": { -"$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction", -"description": "Search action." +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AssistantContentFile": { +"description": "A file, e.g., an audio summary.", +"id": "GoogleCloudDiscoveryengineV1AssistantContentFile", +"properties": { +"fileId": { +"description": "Required. The file ID.", +"type": "string" +}, +"mimeType": { +"description": "Required. The media type (MIME type) of the file.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1AnswerStepActionObservation": { -"description": "Observation.", -"id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservation", +"GoogleCloudDiscoveryengineV1AssistantGroundedContent": { +"description": "A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like \"Of course, I will gladly search it for you.\" do not need grounding.", +"id": "GoogleCloudDiscoveryengineV1AssistantGroundedContent", "properties": { -"searchResults": { -"description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult" +"content": { +"$ref": "GoogleCloudDiscoveryengineV1AssistantContent", +"description": "The content." }, -"type": "array" +"textGroundingMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadata", +"description": "Metadata for grounding based on text sources." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult": { -"id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult", +"GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadata": { +"description": "Grounding details for text sources.", +"id": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadata", "properties": { -"chunkInfo": { -"description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", +"references": { +"description": "References for the grounded text.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo" +"$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference" }, "type": "array" }, -"document": { -"description": "Document resource name.", -"type": "string" -}, -"snippetInfo": { -"description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", +"segments": { +"description": "Grounding information for parts of the text.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo" +"$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataSegment" }, "type": "array" +} }, -"structData": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"type": "object" +}, +"GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference": { +"description": "Referenced content and related document metadata.", +"id": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference", +"properties": { +"content": { +"description": "Referenced text content.", +"type": "string" +}, +"documentMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata", +"description": "Document metadata." +} }, -"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.", "type": "object" }, +"GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata": { +"description": "Document metadata.", +"id": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata", +"properties": { +"document": { +"description": "Document resource name.", +"type": "string" +}, +"domain": { +"description": "Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.", +"type": "string" +}, +"pageIdentifier": { +"description": "Page identifier.", +"type": "string" +}, "title": { "description": "Title.", "type": "string" }, "uri": { -"description": "URI for the document.", +"description": "URI for the document. It may contain a URL that redirects to the actual website.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo": { -"description": "Chunk information.", -"id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo", +"GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataSegment": { +"description": "Grounding information for a segment of the text.", +"id": "GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataSegment", "properties": { -"chunk": { -"description": "Chunk resource name.", -"type": "string" -}, -"content": { -"description": "Chunk textual content.", +"endIndex": { +"description": "End of the segment, exclusive.", +"format": "int64", "type": "string" }, -"relevanceScore": { -"description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", +"groundingScore": { +"description": "Score for the segment.", "format": "float", "type": "number" -} }, -"type": "object" +"referenceIndices": { +"description": "References for the segment.", +"items": { +"format": "int32", +"type": "integer" }, -"GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo": { -"description": "Snippet information.", -"id": "GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo", -"properties": { -"snippet": { -"description": "Snippet content.", -"type": "string" +"type": "array" }, -"snippetStatus": { -"description": "Status of the snippet defined by the search team.", +"startIndex": { +"description": "Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one).", +"format": "int64", "type": "string" -} -}, -"type": "object" }, -"GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction": { -"description": "Search action.", -"id": "GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction", -"properties": { -"query": { -"description": "The query to search.", +"text": { +"description": "The text segment itself.", "type": "string" } }, @@ -10817,6 +11559,10 @@ "description": "The layout parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", "properties": { +"enableGetProcessedDocument": { +"description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.", +"type": "boolean" +}, "enableImageAnnotation": { "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", "type": "boolean" @@ -10971,7 +11717,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", "type": "object" }, "industryVertical": { @@ -11627,7 +12373,7 @@ "description": "Cloud Storage location for the input content." }, "idField": { -"description": "The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{\"my_id\": \"some_uuid\"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.", +"description": "The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{\"my_id\": \"some_uuid\"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * BigtableSource.", "type": "string" }, "inlineSource": { @@ -13067,7 +13813,7 @@ "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." }, "session": { -"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", "type": "string" }, "sessionSpec": { @@ -14294,6 +15040,148 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1StreamAssistRequest": { +"description": "Request for the AssistantService.StreamAssist method.", +"id": "GoogleCloudDiscoveryengineV1StreamAssistRequest", +"properties": { +"generationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestGenerationSpec", +"description": "Optional. Specification of the generation configuration for the request." +}, +"query": { +"$ref": "GoogleCloudDiscoveryengineV1Query", +"description": "Optional. Current user query. Empty query is only supported if `file_ids` are provided. In this case, the answer will be generated based on those context files." +}, +"session": { +"description": "Optional. The session to use for the request. If specified, the assistant has access to the session history, and the query and the answer are stored there. If `-` is specified as the session ID, or it is left empty, then a new session is created with an automatically generated ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`", +"type": "string" +}, +"toolsSpec": { +"$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpec", +"description": "Optional. Specification of tools that are used to serve the request." +}, +"userMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1AssistUserMetadata", +"description": "Optional. Information about the user initiating the query." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1StreamAssistRequestGenerationSpec": { +"description": "Assistant generation specification for the request. This allows to override the default generation configuration at the engine level.", +"id": "GoogleCloudDiscoveryengineV1StreamAssistRequestGenerationSpec", +"properties": { +"modelId": { +"description": "Optional. The Vertex AI model_id used for the generative model. If not set, the default Assistant model will be used.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpec": { +"description": "Specification of tools that are used to serve the request.", +"id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpec", +"properties": { +"imageGenerationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecImageGenerationSpec", +"description": "Optional. Specification of the image generation tool." +}, +"toolRegistry": { +"description": "Optional. The name of the tool registry to use. Format: `projects/{project}/locations/{location}/toolRegistries/{tool_registry}`", +"type": "string" +}, +"vertexAiSearchSpec": { +"$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVertexAiSearchSpec", +"description": "Optional. Specification of the Vertex AI Search tool." +}, +"videoGenerationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVideoGenerationSpec", +"description": "Optional. Specification of the video generation tool." +}, +"webGroundingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecWebGroundingSpec", +"description": "Optional. Specification of the web grounding tool. If field is present, enables grounding with web search. Works only if Assistant.web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecImageGenerationSpec": { +"description": "Specification of the image generation tool.", +"id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecImageGenerationSpec", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVertexAiSearchSpec": { +"description": "Specification of the Vertex AI Search tool.", +"id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVertexAiSearchSpec", +"properties": { +"dataStoreSpecs": { +"description": "Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec" +}, +"type": "array" +}, +"disabled": { +"deprecated": true, +"description": "Optional. Deprecated. Please refrain from using this field. Whether the Vertex AI Search tool is disabled. Default value is false, the tool is enabled by default.", +"type": "boolean" +}, +"filter": { +"description": "Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVideoGenerationSpec": { +"description": "Specification of the video generation tool.", +"id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecVideoGenerationSpec", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecWebGroundingSpec": { +"description": "Specification of the web grounding tool.", +"id": "GoogleCloudDiscoveryengineV1StreamAssistRequestToolsSpecWebGroundingSpec", +"properties": { +"enabled": { +"deprecated": true, +"description": "Optional. Deprecated. Please refrain from using this field. Whether the web grounding tool is enabled.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1StreamAssistResponse": { +"description": "Response for the AssistantService.StreamAssist method.", +"id": "GoogleCloudDiscoveryengineV1StreamAssistResponse", +"properties": { +"answer": { +"$ref": "GoogleCloudDiscoveryengineV1AssistAnswer", +"description": "Assist answer resource object containing parts of the assistant's final answer for the user's query. Not present if the current response doesn't add anything to previously sent AssistAnswer.replies. Observe AssistAnswer.state to see if more parts are to be expected. While the state is `IN_PROGRESS`, the AssistAnswer.replies field in each response will contain replies (reply fragments) to be appended to the ones received in previous responses. AssistAnswer.name won't be filled. If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response is the last response and AssistAnswer.name will have a value." +}, +"assistToken": { +"description": "A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.", +"type": "string" +}, +"sessionInfo": { +"$ref": "GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo", +"description": "Session information." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo": { +"description": "Information about the session.", +"id": "GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo", +"properties": { +"session": { +"description": "Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1SuggestionDenyListEntry": { "description": "Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.", "id": "GoogleCloudDiscoveryengineV1SuggestionDenyListEntry", @@ -14776,14 +15664,16 @@ "ASSIGNED", "UNASSIGNED", "NO_LICENSE", -"NO_LICENSE_ATTEMPTED_LOGIN" +"NO_LICENSE_ATTEMPTED_LOGIN", +"BLOCKED" ], "enumDescriptions": [ "Default value.", "License assigned to the user.", "No license assigned to the user. Deprecated, translated to NO_LICENSE.", "No license assigned to the user.", -"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)." +"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).", +"User is blocked from assigning a license." ], "readOnly": true, "type": "string" @@ -16710,14 +17600,12 @@ "enum": [ "PERIODIC", "STREAMING", -"UNSPECIFIED", -"SCALA_SYNC" +"UNSPECIFIED" ], "enumDescriptions": [ "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.", "The data will be synced in real time.", -"Connector that doesn't ingest data will have this value", -"The data will be synced with Scala Sync, a data ingestion solution." +"Connector that doesn't ingest data will have this value" ], "type": "string" }, @@ -17351,6 +18239,10 @@ "description": "The layout parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", "properties": { +"enableGetProcessedDocument": { +"description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.", +"type": "boolean" +}, "enableImageAnnotation": { "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", "type": "boolean" @@ -17484,7 +18376,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", "type": "object" }, "industryVertical": { @@ -19444,7 +20336,7 @@ false "type": "string" }, "session": { -"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", "type": "string" }, "sessionSpec": { @@ -20615,14 +21507,16 @@ false "ASSIGNED", "UNASSIGNED", "NO_LICENSE", -"NO_LICENSE_ATTEMPTED_LOGIN" +"NO_LICENSE_ATTEMPTED_LOGIN", +"BLOCKED" ], "enumDescriptions": [ "Default value.", "License assigned to the user.", "No license assigned to the user. Deprecated, translated to NO_LICENSE.", "No license assigned to the user.", -"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)." +"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).", +"User is blocked from assigning a license." ], "readOnly": true, "type": "string" @@ -21674,6 +22568,10 @@ false "description": "The layout parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", "properties": { +"enableGetProcessedDocument": { +"description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.", +"type": "boolean" +}, "enableImageAnnotation": { "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", "type": "boolean" @@ -21807,7 +22705,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", "type": "object" }, "industryVertical": { @@ -23057,7 +23955,7 @@ false "type": "string" }, "session": { -"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", "type": "string" }, "sessionSpec": { @@ -24045,14 +24943,16 @@ false "ASSIGNED", "UNASSIGNED", "NO_LICENSE", -"NO_LICENSE_ATTEMPTED_LOGIN" +"NO_LICENSE_ATTEMPTED_LOGIN", +"BLOCKED" ], "enumDescriptions": [ "Default value.", "License assigned to the user.", "No license assigned to the user. Deprecated, translated to NO_LICENSE.", "No license assigned to the user.", -"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)." +"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).", +"User is blocked from assigning a license." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 16d8f2c4d26..932e9227191 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -38,6 +38,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://discoveryengine.eu.rep.googleapis.com/", "location": "eu" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://discoveryengine.in.rep.googleapis.com/", +"location": "in" } ], "fullyEncodeReservedExpansion": true, @@ -4213,6 +4218,38 @@ } }, "resources": { +"assistants": { +"methods": { +"streamAssist": { +"description": "Assists the user with a query in a streaming fashion.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}:streamAssist", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.engines.assistants.streamAssist", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:streamAssist", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "completionConfig": { "methods": { "completeQuery": { @@ -9216,7 +9253,7 @@ } } }, -"revision": "20250706", +"revision": "20250716", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "ApiservingMediaRequestInfo": { @@ -11228,6 +11265,10 @@ "description": "The layout parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", "properties": { +"enableGetProcessedDocument": { +"description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.", +"type": "boolean" +}, "enableImageAnnotation": { "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", "type": "boolean" @@ -11361,7 +11402,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", "type": "object" }, "industryVertical": { @@ -12761,14 +12802,16 @@ "ASSIGNED", "UNASSIGNED", "NO_LICENSE", -"NO_LICENSE_ATTEMPTED_LOGIN" +"NO_LICENSE_ATTEMPTED_LOGIN", +"BLOCKED" ], "enumDescriptions": [ "Default value.", "License assigned to the user.", "No license assigned to the user. Deprecated, translated to NO_LICENSE.", "No license assigned to the user.", -"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)." +"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).", +"User is blocked from assigning a license." ], "readOnly": true, "type": "string" @@ -14603,6 +14646,297 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAssistAnswer": { +"description": "AssistAnswer resource, main part of AssistResponse.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistAnswer", +"properties": { +"assistSkippedReasons": { +"description": "Reasons for not answering the assist call.", +"items": { +"enum": [ +"ASSIST_SKIPPED_REASON_UNSPECIFIED", +"NON_ASSIST_SEEKING_QUERY_IGNORED", +"CUSTOMER_POLICY_VIOLATION" +], +"enumDescriptions": [ +"Default value. Skip reason is not specified.", +"The assistant ignored the query, because it did not appear to be answer-seeking.", +"The assistant ignored the query or refused to answer because of a customer policy violation (e.g., the query or the answer contained a banned phrase)." +], +"type": "string" +}, +"type": "array" +}, +"replies": { +"description": "Replies of the assistant.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswerReply" +}, +"type": "array" +}, +"state": { +"description": "State of the answer generation.", +"enum": [ +"STATE_UNSPECIFIED", +"IN_PROGRESS", +"FAILED", +"SUCCEEDED", +"SKIPPED" +], +"enumDescriptions": [ +"Unknown.", +"Assist operation is currently in progress.", +"Assist operation has failed.", +"Assist operation has succeeded.", +"Assist operation has been skipped." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistAnswerReply": { +"description": "One part of the multi-part response of the assist call.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistAnswerReply", +"properties": { +"groundedContent": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent", +"description": "Possibly grounded response text or media from the assistant." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistUserMetadata": { +"description": "User metadata of the request.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistUserMetadata", +"properties": { +"preferredLanguageCode": { +"description": "Optional. Preferred language to be used for answering if language detection fails. Also used as the language of error messages created by actions, regardless of language detection results.", +"type": "string" +}, +"timeZone": { +"description": "Optional. IANA time zone, e.g. Europe/Budapest.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantContent": { +"description": "Multi-modal content.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantContent", +"properties": { +"codeExecutionResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult", +"description": "Result of executing an ExecutableCode." +}, +"executableCode": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode", +"description": "Code generated by the model that is meant to be executed." +}, +"file": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentFile", +"description": "A file, e.g., an audio summary." +}, +"inlineData": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContentBlob", +"description": "Inline binary data." +}, +"role": { +"description": "The producer of the content. Can be \"model\" or \"user\".", +"type": "string" +}, +"text": { +"description": "Inline text.", +"type": "string" +}, +"thought": { +"description": "Optional. Indicates if the part is thought from the model.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantContentBlob": { +"description": "Inline blob.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantContentBlob", +"properties": { +"data": { +"description": "Required. Raw bytes.", +"format": "byte", +"type": "string" +}, +"mimeType": { +"description": "Required. The media type (MIME type) of the generated data.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult": { +"description": "Result of executing ExecutableCode.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantContentCodeExecutionResult", +"properties": { +"outcome": { +"description": "Required. Outcome of the code execution.", +"enum": [ +"OUTCOME_UNSPECIFIED", +"OUTCOME_OK", +"OUTCOME_FAILED", +"OUTCOME_DEADLINE_EXCEEDED" +], +"enumDescriptions": [ +"Unspecified status. This value should not be used.", +"Code execution completed successfully.", +"Code execution finished but with a failure. `stderr` should contain the reason.", +"Code execution ran for too long, and was cancelled. There may or may not be a partial output present." +], +"type": "string" +}, +"output": { +"description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode": { +"description": "Code generated by the model that is meant to be executed by the model.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantContentExecutableCode", +"properties": { +"code": { +"description": "Required. The code content. Currently only supports Python.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantContentFile": { +"description": "A file, e.g., an audio summary.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantContentFile", +"properties": { +"fileId": { +"description": "Required. The file ID.", +"type": "string" +}, +"mimeType": { +"description": "Required. The media type (MIME type) of the file.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent": { +"description": "A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like \"Of course, I will gladly search it for you.\" do not need grounding.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent", +"properties": { +"content": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantContent", +"description": "The content." +}, +"textGroundingMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata", +"description": "Metadata for grounding based on text sources." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata": { +"description": "Grounding details for text sources.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadata", +"properties": { +"references": { +"description": "References for the grounded text.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference" +}, +"type": "array" +}, +"segments": { +"description": "Grounding information for parts of the text.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference": { +"description": "Referenced content and related document metadata.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference", +"properties": { +"content": { +"description": "Referenced text content.", +"type": "string" +}, +"documentMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata", +"description": "Document metadata." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata": { +"description": "Document metadata.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata", +"properties": { +"document": { +"description": "Document resource name.", +"type": "string" +}, +"domain": { +"description": "Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.", +"type": "string" +}, +"pageIdentifier": { +"description": "Page identifier.", +"type": "string" +}, +"title": { +"description": "Title.", +"type": "string" +}, +"uri": { +"description": "URI for the document. It may contain a URL that redirects to the actual website.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment": { +"description": "Grounding information for a segment of the text.", +"id": "GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataSegment", +"properties": { +"endIndex": { +"description": "End of the segment, exclusive.", +"format": "int64", +"type": "string" +}, +"groundingScore": { +"description": "Score for the segment.", +"format": "float", +"type": "number" +}, +"referenceIndices": { +"description": "References for the segment.", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"startIndex": { +"description": "Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one).", +"format": "int64", +"type": "string" +}, +"text": { +"description": "The text segment itself.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaBAPConfig": { "description": "The configuration for the BAP connector.", "id": "GoogleCloudDiscoveryengineV1alphaBAPConfig", @@ -16807,14 +17141,12 @@ "enum": [ "PERIODIC", "STREAMING", -"UNSPECIFIED", -"SCALA_SYNC" +"UNSPECIFIED" ], "enumDescriptions": [ "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.", "The data will be synced in real time.", -"Connector that doesn't ingest data will have this value", -"The data will be synced with Scala Sync, a data ingestion solution." +"Connector that doesn't ingest data will have this value" ], "type": "string" }, @@ -17633,6 +17965,10 @@ "description": "The layout parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", "properties": { +"enableGetProcessedDocument": { +"description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.", +"type": "boolean" +}, "enableImageAnnotation": { "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", "type": "boolean" @@ -17798,7 +18134,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", "type": "object" }, "industryVertical": { @@ -19005,7 +19341,7 @@ "description": "Cloud Storage location for the input content." }, "idField": { -"description": "The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{\"my_id\": \"some_uuid\"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.", +"description": "The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{\"my_id\": \"some_uuid\"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * BigtableSource.", "type": "string" }, "inlineSource": { @@ -21541,7 +21877,7 @@ false "type": "string" }, "session": { -"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", "type": "string" }, "sessionSpec": { @@ -23457,6 +23793,148 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaStreamAssistRequest": { +"description": "Request for the AssistantService.StreamAssist method.", +"id": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequest", +"properties": { +"generationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestGenerationSpec", +"description": "Optional. Specification of the generation configuration for the request." +}, +"query": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQuery", +"description": "Optional. Current user query. Empty query is only supported if `file_ids` are provided. In this case, the answer will be generated based on those context files." +}, +"session": { +"description": "Optional. The session to use for the request. If specified, the assistant has access to the session history, and the query and the answer are stored there. If `-` is specified as the session ID, or it is left empty, then a new session is created with an automatically generated ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`", +"type": "string" +}, +"toolsSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpec", +"description": "Optional. Specification of tools that are used to serve the request." +}, +"userMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistUserMetadata", +"description": "Optional. Information about the user initiating the query." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaStreamAssistRequestGenerationSpec": { +"description": "Assistant generation specification for the request. This allows to override the default generation configuration at the engine level.", +"id": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestGenerationSpec", +"properties": { +"modelId": { +"description": "Optional. The Vertex AI model_id used for the generative model. If not set, the default Assistant model will be used.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpec": { +"description": "Specification of tools that are used to serve the request.", +"id": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpec", +"properties": { +"imageGenerationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecImageGenerationSpec", +"description": "Optional. Specification of the image generation tool." +}, +"toolRegistry": { +"description": "Optional. The name of the tool registry to use. Format: `projects/{project}/locations/{location}/toolRegistries/{tool_registry}`", +"type": "string" +}, +"vertexAiSearchSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecVertexAiSearchSpec", +"description": "Optional. Specification of the Vertex AI Search tool." +}, +"videoGenerationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecVideoGenerationSpec", +"description": "Optional. Specification of the video generation tool." +}, +"webGroundingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecWebGroundingSpec", +"description": "Optional. Specification of the web grounding tool. If field is present, enables grounding with web search. Works only if Assistant.web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecImageGenerationSpec": { +"description": "Specification of the image generation tool.", +"id": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecImageGenerationSpec", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecVertexAiSearchSpec": { +"description": "Specification of the Vertex AI Search tool.", +"id": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecVertexAiSearchSpec", +"properties": { +"dataStoreSpecs": { +"description": "Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" +}, +"type": "array" +}, +"disabled": { +"deprecated": true, +"description": "Optional. Deprecated. Please refrain from using this field. Whether the Vertex AI Search tool is disabled. Default value is false, the tool is enabled by default.", +"type": "boolean" +}, +"filter": { +"description": "Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecVideoGenerationSpec": { +"description": "Specification of the video generation tool.", +"id": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecVideoGenerationSpec", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecWebGroundingSpec": { +"description": "Specification of the web grounding tool.", +"id": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequestToolsSpecWebGroundingSpec", +"properties": { +"enabled": { +"deprecated": true, +"description": "Optional. Deprecated. Please refrain from using this field. Whether the web grounding tool is enabled.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaStreamAssistResponse": { +"description": "Response for the AssistantService.StreamAssist method.", +"id": "GoogleCloudDiscoveryengineV1alphaStreamAssistResponse", +"properties": { +"answer": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAssistAnswer", +"description": "Assist answer resource object containing parts of the assistant's final answer for the user's query. Not present if the current response doesn't add anything to previously sent AssistAnswer.replies. Observe AssistAnswer.state to see if more parts are to be expected. While the state is `IN_PROGRESS`, the AssistAnswer.replies field in each response will contain replies (reply fragments) to be appended to the ones received in previous responses. AssistAnswer.name won't be filled. If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response is the last response and AssistAnswer.name will have a value." +}, +"assistToken": { +"description": "A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.", +"type": "string" +}, +"sessionInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo", +"description": "Session information." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo": { +"description": "Information about the session.", +"id": "GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo", +"properties": { +"session": { +"description": "Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry": { "description": "Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.", "id": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry", @@ -24014,14 +24492,16 @@ false "ASSIGNED", "UNASSIGNED", "NO_LICENSE", -"NO_LICENSE_ATTEMPTED_LOGIN" +"NO_LICENSE_ATTEMPTED_LOGIN", +"BLOCKED" ], "enumDescriptions": [ "Default value.", "License assigned to the user.", "No license assigned to the user. Deprecated, translated to NO_LICENSE.", "No license assigned to the user.", -"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)." +"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).", +"User is blocked from assigning a license." ], "readOnly": true, "type": "string" @@ -24672,7 +25152,7 @@ false ], "type": "string" }, -"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`", +"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", "readOnly": true, "type": "object" }, @@ -25800,6 +26280,10 @@ false "description": "The layout parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", "properties": { +"enableGetProcessedDocument": { +"description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.", +"type": "boolean" +}, "enableImageAnnotation": { "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", "type": "boolean" @@ -25933,7 +26417,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", "type": "object" }, "industryVertical": { @@ -27183,7 +27667,7 @@ false "type": "string" }, "session": { -"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", "type": "string" }, "sessionSpec": { @@ -28171,14 +28655,16 @@ false "ASSIGNED", "UNASSIGNED", "NO_LICENSE", -"NO_LICENSE_ATTEMPTED_LOGIN" +"NO_LICENSE_ATTEMPTED_LOGIN", +"BLOCKED" ], "enumDescriptions": [ "Default value.", "License assigned to the user.", "No license assigned to the user. Deprecated, translated to NO_LICENSE.", "No license assigned to the user.", -"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)." +"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).", +"User is blocked from assigning a license." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index c12799ff234..dbd57808414 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -4,6 +4,9 @@ "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +}, +"https://www.googleapis.com/auth/cloud_search.query": { +"description": "Search your organization's data in the Cloud Search index" } } } @@ -35,6 +38,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://discoveryengine.eu.rep.googleapis.com/", "location": "eu" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://discoveryengine.in.rep.googleapis.com/", +"location": "in" } ], "fullyEncodeReservedExpansion": true, @@ -1159,7 +1167,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud_search.query" ] } } @@ -3414,6 +3423,38 @@ } }, "resources": { +"assistants": { +"methods": { +"streamAssist": { +"description": "Assists the user with a query in a streaming fashion.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}:streamAssist", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.engines.assistants.streamAssist", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}:streamAssist", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaStreamAssistRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaStreamAssistResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "completionConfig": { "methods": { "completeQuery": { @@ -3441,7 +3482,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud_search.query" ] }, "removeSuggestion": { @@ -5045,7 +5087,8 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud_search.query" ] } } @@ -8004,7 +8047,7 @@ } } }, -"revision": "20250706", +"revision": "20250716", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -9424,6 +9467,10 @@ "description": "The layout parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", "properties": { +"enableGetProcessedDocument": { +"description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.", +"type": "boolean" +}, "enableImageAnnotation": { "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", "type": "boolean" @@ -9557,7 +9604,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", "type": "object" }, "industryVertical": { @@ -10957,14 +11004,16 @@ "ASSIGNED", "UNASSIGNED", "NO_LICENSE", -"NO_LICENSE_ATTEMPTED_LOGIN" +"NO_LICENSE_ATTEMPTED_LOGIN", +"BLOCKED" ], "enumDescriptions": [ "Default value.", "License assigned to the user.", "No license assigned to the user. Deprecated, translated to NO_LICENSE.", "No license assigned to the user.", -"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)." +"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).", +"User is blocked from assigning a license." ], "readOnly": true, "type": "string" @@ -12891,14 +12940,12 @@ "enum": [ "PERIODIC", "STREAMING", -"UNSPECIFIED", -"SCALA_SYNC" +"UNSPECIFIED" ], "enumDescriptions": [ "The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.", "The data will be synced in real time.", -"Connector that doesn't ingest data will have this value", -"The data will be synced with Scala Sync, a data ingestion solution." +"Connector that doesn't ingest data will have this value" ], "type": "string" }, @@ -13532,6 +13579,10 @@ "description": "The layout parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", "properties": { +"enableGetProcessedDocument": { +"description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.", +"type": "boolean" +}, "enableImageAnnotation": { "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", "type": "boolean" @@ -13665,7 +13716,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", "type": "object" }, "industryVertical": { @@ -15625,7 +15676,7 @@ false "type": "string" }, "session": { -"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", "type": "string" }, "sessionSpec": { @@ -16796,14 +16847,16 @@ false "ASSIGNED", "UNASSIGNED", "NO_LICENSE", -"NO_LICENSE_ATTEMPTED_LOGIN" +"NO_LICENSE_ATTEMPTED_LOGIN", +"BLOCKED" ], "enumDescriptions": [ "Default value.", "License assigned to the user.", "No license assigned to the user. Deprecated, translated to NO_LICENSE.", "No license assigned to the user.", -"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)." +"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).", +"User is blocked from assigning a license." ], "readOnly": true, "type": "string" @@ -18531,6 +18584,297 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaAssistAnswer": { +"description": "AssistAnswer resource, main part of AssistResponse.", +"id": "GoogleCloudDiscoveryengineV1betaAssistAnswer", +"properties": { +"assistSkippedReasons": { +"description": "Reasons for not answering the assist call.", +"items": { +"enum": [ +"ASSIST_SKIPPED_REASON_UNSPECIFIED", +"NON_ASSIST_SEEKING_QUERY_IGNORED", +"CUSTOMER_POLICY_VIOLATION" +], +"enumDescriptions": [ +"Default value. Skip reason is not specified.", +"The assistant ignored the query, because it did not appear to be answer-seeking.", +"The assistant ignored the query or refused to answer because of a customer policy violation (e.g., the query or the answer contained a banned phrase)." +], +"type": "string" +}, +"type": "array" +}, +"replies": { +"description": "Replies of the assistant.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaAssistAnswerReply" +}, +"type": "array" +}, +"state": { +"description": "State of the answer generation.", +"enum": [ +"STATE_UNSPECIFIED", +"IN_PROGRESS", +"FAILED", +"SUCCEEDED", +"SKIPPED" +], +"enumDescriptions": [ +"Unknown.", +"Assist operation is currently in progress.", +"Assist operation has failed.", +"Assist operation has succeeded.", +"Assist operation has been skipped." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAssistAnswerReply": { +"description": "One part of the multi-part response of the assist call.", +"id": "GoogleCloudDiscoveryengineV1betaAssistAnswerReply", +"properties": { +"groundedContent": { +"$ref": "GoogleCloudDiscoveryengineV1betaAssistantGroundedContent", +"description": "Possibly grounded response text or media from the assistant." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAssistUserMetadata": { +"description": "User metadata of the request.", +"id": "GoogleCloudDiscoveryengineV1betaAssistUserMetadata", +"properties": { +"preferredLanguageCode": { +"description": "Optional. Preferred language to be used for answering if language detection fails. Also used as the language of error messages created by actions, regardless of language detection results.", +"type": "string" +}, +"timeZone": { +"description": "Optional. IANA time zone, e.g. Europe/Budapest.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAssistantContent": { +"description": "Multi-modal content.", +"id": "GoogleCloudDiscoveryengineV1betaAssistantContent", +"properties": { +"codeExecutionResult": { +"$ref": "GoogleCloudDiscoveryengineV1betaAssistantContentCodeExecutionResult", +"description": "Result of executing an ExecutableCode." +}, +"executableCode": { +"$ref": "GoogleCloudDiscoveryengineV1betaAssistantContentExecutableCode", +"description": "Code generated by the model that is meant to be executed." +}, +"file": { +"$ref": "GoogleCloudDiscoveryengineV1betaAssistantContentFile", +"description": "A file, e.g., an audio summary." +}, +"inlineData": { +"$ref": "GoogleCloudDiscoveryengineV1betaAssistantContentBlob", +"description": "Inline binary data." +}, +"role": { +"description": "The producer of the content. Can be \"model\" or \"user\".", +"type": "string" +}, +"text": { +"description": "Inline text.", +"type": "string" +}, +"thought": { +"description": "Optional. Indicates if the part is thought from the model.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAssistantContentBlob": { +"description": "Inline blob.", +"id": "GoogleCloudDiscoveryengineV1betaAssistantContentBlob", +"properties": { +"data": { +"description": "Required. Raw bytes.", +"format": "byte", +"type": "string" +}, +"mimeType": { +"description": "Required. The media type (MIME type) of the generated data.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAssistantContentCodeExecutionResult": { +"description": "Result of executing ExecutableCode.", +"id": "GoogleCloudDiscoveryengineV1betaAssistantContentCodeExecutionResult", +"properties": { +"outcome": { +"description": "Required. Outcome of the code execution.", +"enum": [ +"OUTCOME_UNSPECIFIED", +"OUTCOME_OK", +"OUTCOME_FAILED", +"OUTCOME_DEADLINE_EXCEEDED" +], +"enumDescriptions": [ +"Unspecified status. This value should not be used.", +"Code execution completed successfully.", +"Code execution finished but with a failure. `stderr` should contain the reason.", +"Code execution ran for too long, and was cancelled. There may or may not be a partial output present." +], +"type": "string" +}, +"output": { +"description": "Optional. Contains stdout when code execution is successful, stderr or other description otherwise.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAssistantContentExecutableCode": { +"description": "Code generated by the model that is meant to be executed by the model.", +"id": "GoogleCloudDiscoveryengineV1betaAssistantContentExecutableCode", +"properties": { +"code": { +"description": "Required. The code content. Currently only supports Python.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAssistantContentFile": { +"description": "A file, e.g., an audio summary.", +"id": "GoogleCloudDiscoveryengineV1betaAssistantContentFile", +"properties": { +"fileId": { +"description": "Required. The file ID.", +"type": "string" +}, +"mimeType": { +"description": "Required. The media type (MIME type) of the file.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAssistantGroundedContent": { +"description": "A piece of content and possibly its grounding information. Not all content needs grounding. Phrases like \"Of course, I will gladly search it for you.\" do not need grounding.", +"id": "GoogleCloudDiscoveryengineV1betaAssistantGroundedContent", +"properties": { +"content": { +"$ref": "GoogleCloudDiscoveryengineV1betaAssistantContent", +"description": "The content." +}, +"textGroundingMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadata", +"description": "Metadata for grounding based on text sources." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadata": { +"description": "Grounding details for text sources.", +"id": "GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadata", +"properties": { +"references": { +"description": "References for the grounded text.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReference" +}, +"type": "array" +}, +"segments": { +"description": "Grounding information for parts of the text.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataSegment" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReference": { +"description": "Referenced content and related document metadata.", +"id": "GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReference", +"properties": { +"content": { +"description": "Referenced text content.", +"type": "string" +}, +"documentMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata", +"description": "Document metadata." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata": { +"description": "Document metadata.", +"id": "GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata", +"properties": { +"document": { +"description": "Document resource name.", +"type": "string" +}, +"domain": { +"description": "Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.", +"type": "string" +}, +"pageIdentifier": { +"description": "Page identifier.", +"type": "string" +}, +"title": { +"description": "Title.", +"type": "string" +}, +"uri": { +"description": "URI for the document. It may contain a URL that redirects to the actual website.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataSegment": { +"description": "Grounding information for a segment of the text.", +"id": "GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataSegment", +"properties": { +"endIndex": { +"description": "End of the segment, exclusive.", +"format": "int64", +"type": "string" +}, +"groundingScore": { +"description": "Score for the segment.", +"format": "float", +"type": "number" +}, +"referenceIndices": { +"description": "References for the segment.", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"startIndex": { +"description": "Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one).", +"format": "int64", +"type": "string" +}, +"text": { +"description": "The text segment itself.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", @@ -20674,6 +21018,10 @@ false "description": "The layout parsing configurations for documents.", "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", "properties": { +"enableGetProcessedDocument": { +"description": "Optional. If true, the processed document will be made available for the GetProcessedDocument API.", +"type": "boolean" +}, "enableImageAnnotation": { "description": "Optional. If true, the LLM based annotation is added to the image during parsing.", "type": "boolean" @@ -20839,7 +21187,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.", "type": "object" }, "industryVertical": { @@ -21585,7 +21933,7 @@ false "description": "Cloud Storage location for the input content." }, "idField": { -"description": "The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{\"my_id\": \"some_uuid\"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.", +"description": "The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{\"my_id\": \"some_uuid\"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * BigtableSource.", "type": "string" }, "inlineSource": { @@ -23621,7 +23969,7 @@ false "type": "string" }, "session": { -"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", "type": "string" }, "sessionSpec": { @@ -25413,6 +25761,148 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaStreamAssistRequest": { +"description": "Request for the AssistantService.StreamAssist method.", +"id": "GoogleCloudDiscoveryengineV1betaStreamAssistRequest", +"properties": { +"generationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaStreamAssistRequestGenerationSpec", +"description": "Optional. Specification of the generation configuration for the request." +}, +"query": { +"$ref": "GoogleCloudDiscoveryengineV1betaQuery", +"description": "Optional. Current user query. Empty query is only supported if `file_ids` are provided. In this case, the answer will be generated based on those context files." +}, +"session": { +"description": "Optional. The session to use for the request. If specified, the assistant has access to the session history, and the query and the answer are stored there. If `-` is specified as the session ID, or it is left empty, then a new session is created with an automatically generated ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`", +"type": "string" +}, +"toolsSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpec", +"description": "Optional. Specification of tools that are used to serve the request." +}, +"userMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1betaAssistUserMetadata", +"description": "Optional. Information about the user initiating the query." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaStreamAssistRequestGenerationSpec": { +"description": "Assistant generation specification for the request. This allows to override the default generation configuration at the engine level.", +"id": "GoogleCloudDiscoveryengineV1betaStreamAssistRequestGenerationSpec", +"properties": { +"modelId": { +"description": "Optional. The Vertex AI model_id used for the generative model. If not set, the default Assistant model will be used.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpec": { +"description": "Specification of tools that are used to serve the request.", +"id": "GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpec", +"properties": { +"imageGenerationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecImageGenerationSpec", +"description": "Optional. Specification of the image generation tool." +}, +"toolRegistry": { +"description": "Optional. The name of the tool registry to use. Format: `projects/{project}/locations/{location}/toolRegistries/{tool_registry}`", +"type": "string" +}, +"vertexAiSearchSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVertexAiSearchSpec", +"description": "Optional. Specification of the Vertex AI Search tool." +}, +"videoGenerationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVideoGenerationSpec", +"description": "Optional. Specification of the video generation tool." +}, +"webGroundingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecWebGroundingSpec", +"description": "Optional. Specification of the web grounding tool. If field is present, enables grounding with web search. Works only if Assistant.web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecImageGenerationSpec": { +"description": "Specification of the image generation tool.", +"id": "GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecImageGenerationSpec", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVertexAiSearchSpec": { +"description": "Specification of the Vertex AI Search tool.", +"id": "GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVertexAiSearchSpec", +"properties": { +"dataStoreSpecs": { +"description": "Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" +}, +"type": "array" +}, +"disabled": { +"deprecated": true, +"description": "Optional. Deprecated. Please refrain from using this field. Whether the Vertex AI Search tool is disabled. Default value is false, the tool is enabled by default.", +"type": "boolean" +}, +"filter": { +"description": "Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVideoGenerationSpec": { +"description": "Specification of the video generation tool.", +"id": "GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVideoGenerationSpec", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecWebGroundingSpec": { +"description": "Specification of the web grounding tool.", +"id": "GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecWebGroundingSpec", +"properties": { +"enabled": { +"deprecated": true, +"description": "Optional. Deprecated. Please refrain from using this field. Whether the web grounding tool is enabled.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaStreamAssistResponse": { +"description": "Response for the AssistantService.StreamAssist method.", +"id": "GoogleCloudDiscoveryengineV1betaStreamAssistResponse", +"properties": { +"answer": { +"$ref": "GoogleCloudDiscoveryengineV1betaAssistAnswer", +"description": "Assist answer resource object containing parts of the assistant's final answer for the user's query. Not present if the current response doesn't add anything to previously sent AssistAnswer.replies. Observe AssistAnswer.state to see if more parts are to be expected. While the state is `IN_PROGRESS`, the AssistAnswer.replies field in each response will contain replies (reply fragments) to be appended to the ones received in previous responses. AssistAnswer.name won't be filled. If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response is the last response and AssistAnswer.name will have a value." +}, +"assistToken": { +"description": "A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.", +"type": "string" +}, +"sessionInfo": { +"$ref": "GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo", +"description": "Session information." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo": { +"description": "Information about the session.", +"id": "GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo", +"properties": { +"session": { +"description": "Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry": { "description": "Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.", "id": "GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry", @@ -25901,14 +26391,16 @@ false "ASSIGNED", "UNASSIGNED", "NO_LICENSE", -"NO_LICENSE_ATTEMPTED_LOGIN" +"NO_LICENSE_ATTEMPTED_LOGIN", +"BLOCKED" ], "enumDescriptions": [ "Default value.", "License assigned to the user.", "No license assigned to the user. Deprecated, translated to NO_LICENSE.", "No license assigned to the user.", -"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin)." +"User attempted to login but no license assigned to the user. This state is only used for no user first time login attempt but cannot get license assigned. Users already logged in but cannot get license assigned will be assigned NO_LICENSE state(License could be unassigned by admin).", +"User is blocked from assigning a license." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index 8525d85a8e4..a00838e4e4d 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -5118,7 +5118,7 @@ } } }, -"revision": "20250629", +"revision": "20250713", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -8271,6 +8271,21 @@ }, "type": "object" }, +"GooglePrivacyDlpV2DocumentFallbackLocation": { +"description": "Configure document processing to fall back to the configured processing option below if document processing is unavailable in the original request location.", +"id": "GooglePrivacyDlpV2DocumentFallbackLocation", +"properties": { +"globalProcessing": { +"$ref": "GooglePrivacyDlpV2GlobalProcessing", +"description": "Processing will happen in the global region." +}, +"multiRegionProcessing": { +"$ref": "GooglePrivacyDlpV2MultiRegionProcessing", +"description": "Processing will happen in a multi-region that contains the current region if available." +} +}, +"type": "object" +}, "GooglePrivacyDlpV2DocumentLocation": { "description": "Location of a finding within a document.", "id": "GooglePrivacyDlpV2DocumentLocation", @@ -10878,6 +10893,10 @@ "description": "Configure processing location for discovery and inspection. For example, image OCR is only provided in limited regions but configuring ProcessingLocation will redirect OCR to a location where OCR is provided.", "id": "GooglePrivacyDlpV2ProcessingLocation", "properties": { +"documentFallbackLocation": { +"$ref": "GooglePrivacyDlpV2DocumentFallbackLocation", +"description": "Document processing will fall back using this configuration." +}, "imageFallbackLocation": { "$ref": "GooglePrivacyDlpV2ImageFallbackLocation", "description": "Image processing will fall back using this configuration." diff --git a/googleapiclient/discovery_cache/documents/documentai.v1.json b/googleapiclient/discovery_cache/documents/documentai.v1.json index d5b8ff80cd6..e180cc5002f 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1.json @@ -1048,7 +1048,7 @@ } } }, -"revision": "20250616", +"revision": "20250716", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -4560,8 +4560,9 @@ true "id": "GoogleCloudDocumentaiV1Processor", "properties": { "createTime": { -"description": "The time the processor was created.", +"description": "Output only. The time the processor was created.", "format": "google-datetime", +"readOnly": true, "type": "string" }, "defaultProcessorVersion": { @@ -4713,13 +4714,15 @@ true "id": "GoogleCloudDocumentaiV1ProcessorVersion", "properties": { "createTime": { -"description": "The time the processor version was created.", +"description": "Output only. The time the processor version was created.", "format": "google-datetime", +"readOnly": true, "type": "string" }, "deprecationInfo": { "$ref": "GoogleCloudDocumentaiV1ProcessorVersionDeprecationInfo", -"description": "If set, information about the eventual deprecation of this version." +"description": "Output only. If set, information about the eventual deprecation of this version.", +"readOnly": true }, "displayName": { "description": "The display name of the processor version.", @@ -4727,7 +4730,8 @@ true }, "documentSchema": { "$ref": "GoogleCloudDocumentaiV1DocumentSchema", -"description": "The schema of the processor version. Describes the output." +"description": "Output only. The schema of the processor version. Describes the output.", +"readOnly": true }, "genAiModelInfo": { "$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo", @@ -4740,16 +4744,19 @@ true "type": "boolean" }, "kmsKeyName": { -"description": "The KMS key name used for encryption.", +"description": "Output only. The KMS key name used for encryption.", +"readOnly": true, "type": "string" }, "kmsKeyVersionName": { -"description": "The KMS key version with which data is encrypted.", +"description": "Output only. The KMS key version with which data is encrypted.", +"readOnly": true, "type": "string" }, "latestEvaluation": { "$ref": "GoogleCloudDocumentaiV1EvaluationReference", -"description": "The most recently invoked evaluation for the processor version." +"description": "Output only. The most recently invoked evaluation for the processor version.", +"readOnly": true }, "modelType": { "description": "Output only. The model type of this processor version.", diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json index cab7859c67a..bc771e04323 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json @@ -1290,7 +1290,7 @@ } } }, -"revision": "20250616", +"revision": "20250716", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -5986,8 +5986,9 @@ true "id": "GoogleCloudDocumentaiV1beta3Processor", "properties": { "createTime": { -"description": "The time the processor was created.", +"description": "Output only. The time the processor was created.", "format": "google-datetime", +"readOnly": true, "type": "string" }, "defaultProcessorVersion": { @@ -6139,13 +6140,15 @@ true "id": "GoogleCloudDocumentaiV1beta3ProcessorVersion", "properties": { "createTime": { -"description": "The time the processor version was created.", +"description": "Output only. The time the processor version was created.", "format": "google-datetime", +"readOnly": true, "type": "string" }, "deprecationInfo": { "$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo", -"description": "If set, information about the eventual deprecation of this version." +"description": "Output only. If set, information about the eventual deprecation of this version.", +"readOnly": true }, "displayName": { "description": "The display name of the processor version.", @@ -6153,7 +6156,8 @@ true }, "documentSchema": { "$ref": "GoogleCloudDocumentaiV1beta3DocumentSchema", -"description": "The schema of the processor version. Describes the output." +"description": "Output only. The schema of the processor version. Describes the output.", +"readOnly": true }, "genAiModelInfo": { "$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo", @@ -6166,16 +6170,19 @@ true "type": "boolean" }, "kmsKeyName": { -"description": "The KMS key name used for encryption.", +"description": "Output only. The KMS key name used for encryption.", +"readOnly": true, "type": "string" }, "kmsKeyVersionName": { -"description": "The KMS key version with which data is encrypted.", +"description": "Output only. The KMS key version with which data is encrypted.", +"readOnly": true, "type": "string" }, "latestEvaluation": { "$ref": "GoogleCloudDocumentaiV1beta3EvaluationReference", -"description": "The most recently invoked evaluation for the processor version." +"description": "Output only. The most recently invoked evaluation for the processor version.", +"readOnly": true }, "modelType": { "description": "Output only. The model type of this processor version.", diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index c4600edce75..1991f6befaf 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20250618", +"revision": "20250715", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -1365,6 +1365,22 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1GoogleMaps": { +"description": "Tool to retrieve public maps data for grounding, powered by Google.", +"id": "GoogleCloudAiplatformV1beta1GoogleMaps", +"properties": { +"apiAuth": { +"$ref": "GoogleCloudAiplatformV1beta1ApiAuth", +"deprecated": true, +"description": "The authentication config to access the API. Deprecated. Please use auth_config instead." +}, +"authConfig": { +"$ref": "GoogleCloudAiplatformV1beta1AuthConfig", +"description": "The authentication config to access the API. Only API key is supported." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval": { "description": "Tool to retrieve public web data for grounding, powered by Google.", "id": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval", @@ -1380,6 +1396,10 @@ "description": "Grounding chunk.", "id": "GoogleCloudAiplatformV1beta1GroundingChunk", "properties": { +"maps": { +"$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMaps", +"description": "Grounding chunk from Google Maps." +}, "retrievedContext": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext", "description": "Grounding chunk from context retrieved by the retrieval tools." @@ -1391,6 +1411,29 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1GroundingChunkMaps": { +"description": "Chunk from Google Maps.", +"id": "GoogleCloudAiplatformV1beta1GroundingChunkMaps", +"properties": { +"placeId": { +"description": "This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.", +"type": "string" +}, +"text": { +"description": "Text of the chunk.", +"type": "string" +}, +"title": { +"description": "Title of the chunk.", +"type": "string" +}, +"uri": { +"description": "URI reference of the chunk.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext": { "description": "Chunk from context retrieved by the retrieval tools.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext", @@ -1437,6 +1480,11 @@ "description": "Metadata returned to client when grounding is enabled.", "id": "GoogleCloudAiplatformV1beta1GroundingMetadata", "properties": { +"googleMapsWidgetContextToken": { +"description": "Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.", +"readOnly": true, +"type": "string" +}, "groundingChunks": { "description": "List of supporting references retrieved from specified grounding source.", "items": { @@ -2264,12 +2312,16 @@ false "description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance." }, "functionDeclarations": { -"description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided.", +"description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.", "items": { "$ref": "GoogleCloudAiplatformV1beta1FunctionDeclaration" }, "type": "array" }, +"googleMaps": { +"$ref": "GoogleCloudAiplatformV1beta1GoogleMaps", +"description": "Optional. GoogleMaps tool type. Tool to support Google Maps in Model." +}, "googleSearch": { "$ref": "GoogleCloudAiplatformV1beta1ToolGoogleSearch", "description": "Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google." diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index fd3872a1b6b..b68d9442256 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -2117,7 +2117,7 @@ } } }, -"revision": "20250612", +"revision": "20250715", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2510,7 +2510,8 @@ "IN_PROGRESS", "SOAKING", "FORCED_SOAKING", -"COMPLETE" +"COMPLETE", +"FORCED_COMPLETE" ], "enumDescriptions": [ "Required by https://linter.aip.dev/126/unspecified.", @@ -2519,7 +2520,8 @@ "The upgrade is in progress. At the scope level, this means the upgrade is in progress for at least one cluster in the scope.", "The upgrade has finished and is soaking until the soaking time is up. At the scope level, this means at least one cluster is in soaking while the rest are either soaking or complete.", "A cluster will be forced to enter soaking if an upgrade doesn't finish within a certain limit, despite it's actual status.", -"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status." +"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status.", +"The upgrade was forced into soaking and the soaking time has passed. This is the equivalent of COMPLETE status for upgrades that were forced into soaking." ], "type": "string" }, @@ -5014,6 +5016,19 @@ "readOnly": true, "type": "string" }, +"membershipType": { +"description": "Output only. The type of the membership.", +"enum": [ +"MEMBERSHIP_TYPE_UNSPECIFIED", +"LIGHTWEIGHT" +], +"enumDescriptions": [ +"The MembershipType is not set.", +"The membership supports only lightweight compatible features." +], +"readOnly": true, +"type": "string" +}, "monitoringConfig": { "$ref": "MonitoringConfig", "description": "Optional. The monitoring config information for this membership." diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index 50fba81f33a..3632373e937 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -2261,7 +2261,7 @@ } } }, -"revision": "20250612", +"revision": "20250715", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2750,7 +2750,8 @@ "IN_PROGRESS", "SOAKING", "FORCED_SOAKING", -"COMPLETE" +"COMPLETE", +"FORCED_COMPLETE" ], "enumDescriptions": [ "Required by https://linter.aip.dev/126/unspecified.", @@ -2759,7 +2760,8 @@ "The upgrade is in progress. At the scope level, this means the upgrade is in progress for at least one cluster in the scope.", "The upgrade has finished and is soaking until the soaking time is up. At the scope level, this means at least one cluster is in soaking while the rest are either soaking or complete.", "A cluster will be forced to enter soaking if an upgrade doesn't finish within a certain limit, despite it's actual status.", -"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status." +"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status.", +"The upgrade was forced into soaking and the soaking time has passed. This is the equivalent of COMPLETE status for upgrades that were forced into soaking." ], "type": "string" }, @@ -5412,6 +5414,19 @@ "readOnly": true, "type": "string" }, +"membershipType": { +"description": "Output only. The type of the membership.", +"enum": [ +"MEMBERSHIP_TYPE_UNSPECIFIED", +"LIGHTWEIGHT" +], +"enumDescriptions": [ +"The MembershipType is not set.", +"The membership supports only lightweight compatible features." +], +"readOnly": true, +"type": "string" +}, "monitoringConfig": { "$ref": "MonitoringConfig", "description": "Optional. The monitoring config information for this membership." diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index 75623dcc2ac..db921ec79a3 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -2117,7 +2117,7 @@ } } }, -"revision": "20250612", +"revision": "20250715", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2510,7 +2510,8 @@ "IN_PROGRESS", "SOAKING", "FORCED_SOAKING", -"COMPLETE" +"COMPLETE", +"FORCED_COMPLETE" ], "enumDescriptions": [ "Required by https://linter.aip.dev/126/unspecified.", @@ -2519,7 +2520,8 @@ "The upgrade is in progress. At the scope level, this means the upgrade is in progress for at least one cluster in the scope.", "The upgrade has finished and is soaking until the soaking time is up. At the scope level, this means at least one cluster is in soaking while the rest are either soaking or complete.", "A cluster will be forced to enter soaking if an upgrade doesn't finish within a certain limit, despite it's actual status.", -"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status." +"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status.", +"The upgrade was forced into soaking and the soaking time has passed. This is the equivalent of COMPLETE status for upgrades that were forced into soaking." ], "type": "string" }, @@ -5075,6 +5077,19 @@ "readOnly": true, "type": "string" }, +"membershipType": { +"description": "Output only. The type of the membership.", +"enum": [ +"MEMBERSHIP_TYPE_UNSPECIFIED", +"LIGHTWEIGHT" +], +"enumDescriptions": [ +"The MembershipType is not set.", +"The membership supports only lightweight compatible features." +], +"readOnly": true, +"type": "string" +}, "monitoringConfig": { "$ref": "MonitoringConfig", "description": "Optional. The monitoring config information for this membership." diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json index 8b947c2db87..b206b595283 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json @@ -718,7 +718,7 @@ } } }, -"revision": "20250415", +"revision": "20250715", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "ApplianceCluster": { @@ -1197,6 +1197,19 @@ "readOnly": true, "type": "string" }, +"membershipType": { +"description": "Output only. The type of the membership.", +"enum": [ +"MEMBERSHIP_TYPE_UNSPECIFIED", +"LIGHTWEIGHT" +], +"enumDescriptions": [ +"The MembershipType is not set.", +"The membership supports only lightweight compatible features." +], +"readOnly": true, +"type": "string" +}, "monitoringConfig": { "$ref": "MonitoringConfig", "description": "Optional. The monitoring config information for this membership." diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2.json b/googleapiclient/discovery_cache/documents/gkehub.v2.json index 8c26e57f5ac..58103f20d39 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2.json @@ -477,7 +477,7 @@ } } }, -"revision": "20250612", +"revision": "20250715", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -626,7 +626,8 @@ "IN_PROGRESS", "SOAKING", "FORCED_SOAKING", -"COMPLETE" +"COMPLETE", +"FORCED_COMPLETE" ], "enumDescriptions": [ "Required by https://linter.aip.dev/126/unspecified.", @@ -635,7 +636,8 @@ "The upgrade is in progress. At the scope level, this means the upgrade is in progress for at least one cluster in the scope.", "The upgrade has finished and is soaking until the soaking time is up. At the scope level, this means at least one cluster is in soaking while the rest are either soaking or complete.", "A cluster will be forced to enter soaking if an upgrade doesn't finish within a certain limit, despite it's actual status.", -"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status." +"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status.", +"The upgrade was forced into soaking and the soaking time has passed. This is the equivalent of COMPLETE status for upgrades that were forced into soaking." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json index 2819daf7255..be0567b52e4 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json @@ -477,7 +477,7 @@ } } }, -"revision": "20250612", +"revision": "20250715", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -626,7 +626,8 @@ "IN_PROGRESS", "SOAKING", "FORCED_SOAKING", -"COMPLETE" +"COMPLETE", +"FORCED_COMPLETE" ], "enumDescriptions": [ "Required by https://linter.aip.dev/126/unspecified.", @@ -635,7 +636,8 @@ "The upgrade is in progress. At the scope level, this means the upgrade is in progress for at least one cluster in the scope.", "The upgrade has finished and is soaking until the soaking time is up. At the scope level, this means at least one cluster is in soaking while the rest are either soaking or complete.", "A cluster will be forced to enter soaking if an upgrade doesn't finish within a certain limit, despite it's actual status.", -"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status." +"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status.", +"The upgrade was forced into soaking and the soaking time has passed. This is the equivalent of COMPLETE status for upgrades that were forced into soaking." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2beta.json b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json index 10e36a16384..2331ca09677 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json @@ -477,7 +477,7 @@ } } }, -"revision": "20250612", +"revision": "20250715", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -626,7 +626,8 @@ "IN_PROGRESS", "SOAKING", "FORCED_SOAKING", -"COMPLETE" +"COMPLETE", +"FORCED_COMPLETE" ], "enumDescriptions": [ "Required by https://linter.aip.dev/126/unspecified.", @@ -635,7 +636,8 @@ "The upgrade is in progress. At the scope level, this means the upgrade is in progress for at least one cluster in the scope.", "The upgrade has finished and is soaking until the soaking time is up. At the scope level, this means at least one cluster is in soaking while the rest are either soaking or complete.", "A cluster will be forced to enter soaking if an upgrade doesn't finish within a certain limit, despite it's actual status.", -"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status." +"The upgrade has passed all post conditions (soaking). At the scope level, this means all eligible clusters are in COMPLETE status.", +"The upgrade was forced into soaking and the soaking time has passed. This is the equivalent of COMPLETE status for upgrades that were forced into soaking." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1.json b/googleapiclient/discovery_cache/documents/healthcare.v1.json index 284b292921c..734bc8639ee 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1.json @@ -2871,6 +2871,44 @@ } }, "resources": { +"bulkdata": { +"methods": { +"retrieveBulkdata": { +"description": "Returns uncompressed, unencoded bytes representing the referenced bulkdata tag from an instance. See [Retrieve Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4){: .external}. For details on the implementation of RetrieveBulkdata, see [Bulkdata resources](https://cloud.google.com/healthcare/docs/dicom#bulkdata-resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveBulkdata, see [Retrieve bulkdata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-bulkdata).", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/bulkdata/{bulkdataId}/{bulkdataId1}", +"httpMethod": "GET", +"id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.bulkdata.retrieveBulkdata", +"parameterOrder": [ +"parent", +"dicomWebPath" +], +"parameters": { +"dicomWebPath": { +"description": "Required. The path for the `RetrieveBulkdata` DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/bukdata/{bulkdata_uri}`.", +"location": "path", +"pattern": "^studies/[^/]+/series/[^/]+/instances/[^/]+/bulkdata/[^/]+/.*$", +"required": true, +"type": "string" +}, +"parent": { +"description": "Required. The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/dicomWeb/{+dicomWebPath}", +"response": { +"$ref": "HttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-healthcare", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "frames": { "methods": { "retrieveFrames": { @@ -4225,7 +4263,7 @@ ] }, "update": { -"description": "Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update), [R5](https://hl7.org/fhir/R5/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. In R5, the conditional update interaction If-None-Match is supported, including the wildcard behaviour. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).", +"description": "Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update), [R5](https://hl7.org/fhir/R5/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The conditional update interaction If-None-Match is supported, including the wildcard behaviour, as defined by the R5 spec. This functionality is supported in R4 and R5. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}", "httpMethod": "PUT", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.update", @@ -5094,7 +5132,7 @@ } } }, -"revision": "20250526", +"revision": "20250625", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -6134,6 +6172,17 @@ }, "type": "object" }, +"DicomNotificationConfig": { +"description": "Contains the configuration for DICOM notifications.", +"id": "DicomNotificationConfig", +"properties": { +"pubsubTopic": { +"description": "Required. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. * `PubsubMessage.Attributes` contains the following attributes: * `action`: The name of the endpoint that generated the notification. Possible values are `StoreInstances`, `SetBlobSettings`, `ImportDicomData`, etc. * `lastUpdatedTime`: The latest timestamp when the DICOM instance was updated. * `storeName`: The resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * `studyInstanceUID`: The study UID of the DICOM instance that was changed. * `seriesInstanceUID`: The series UID of the DICOM instance that was changed. * `sopInstanceUID`: The instance UID of the DICOM instance that was changed. * `versionId`: The version ID of the DICOM instance that was changed. * `modality`: The modality tag of the DICOM instance that was changed. * `previousStorageClass`: The storage class where the DICOM instance was previously stored if the storage class was changed. * `storageClass`: The storage class where the DICOM instance is currently stored. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have the `pubsub.topics.publish` permission (which is typically included in `roles/pubsub.publisher` role) on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging).", +"type": "string" +} +}, +"type": "object" +}, "DicomStore": { "description": "Represents a DICOM store.", "id": "DicomStore", @@ -6153,6 +6202,13 @@ "$ref": "NotificationConfig", "description": "Optional. Notification destination for new DICOM instances. Supplied by the client." }, +"notificationConfigs": { +"description": "Optional. Specifies where and whether to send notifications upon changes to a DICOM store.", +"items": { +"$ref": "DicomNotificationConfig" +}, +"type": "array" +}, "streamConfigs": { "description": "Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination.", "items": { diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json index 6691a603d83..847bdbdd374 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json @@ -4666,7 +4666,7 @@ ] }, "update": { -"description": "Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update), [R5](https://hl7.org/fhir/R5/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. In R5, the conditional update interaction If-None-Match is supported, including the wildcard behaviour. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).", +"description": "Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#update), [STU3](https://hl7.org/fhir/STU3/http.html#update), [R4](https://hl7.org/fhir/R4/http.html#update), [R5](https://hl7.org/fhir/R5/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The conditional update interaction If-None-Match is supported, including the wildcard behaviour, as defined by the R5 spec. This functionality is supported in R4 and R5. For samples that show how to call `update`, see [Updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}/{fhirId1}", "httpMethod": "PUT", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.update", @@ -5588,7 +5588,7 @@ } } }, -"revision": "20250609", +"revision": "20250625", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -6780,6 +6780,17 @@ }, "type": "object" }, +"DicomNotificationConfig": { +"description": "Contains the configuration for DICOM notifications.", +"id": "DicomNotificationConfig", +"properties": { +"pubsubTopic": { +"description": "Required. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. * `PubsubMessage.Attributes` contains the following attributes: * `action`: The name of the endpoint that generated the notification. Possible values are `StoreInstances`, `SetBlobSettings`, `ImportDicomData`, etc. * `lastUpdatedTime`: The latest timestamp when the DICOM instance was updated. * `storeName`: The resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * `studyInstanceUID`: The study UID of the DICOM instance that was changed. * `seriesInstanceUID`: The series UID of the DICOM instance that was changed. * `sopInstanceUID`: The instance UID of the DICOM instance that was changed. * `versionId`: The version ID of the DICOM instance that was changed. * `modality`: The modality tag of the DICOM instance that was changed. * `previousStorageClass`: The storage class where the DICOM instance was previously stored if the storage class was changed. * `storageClass`: The storage class where the DICOM instance is currently stored. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have the `pubsub.topics.publish` permission (which is typically included in `roles/pubsub.publisher` role) on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging).", +"type": "string" +} +}, +"type": "object" +}, "DicomStore": { "description": "Represents a DICOM store.", "id": "DicomStore", @@ -6799,6 +6810,13 @@ "$ref": "NotificationConfig", "description": "Notification destination for new DICOM instances. Supplied by the client." }, +"notificationConfigs": { +"description": "Optional. Specifies where and whether to send notifications upon changes to a DICOM store.", +"items": { +"$ref": "DicomNotificationConfig" +}, +"type": "array" +}, "streamConfigs": { "description": "Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination.", "items": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json index cd4f688cbd0..9a64e31b233 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json @@ -2311,7 +2311,7 @@ } } }, -"revision": "20250710", +"revision": "20250715", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -5301,14 +5301,16 @@ false "STANDARD", "READ_ONLY", "ADMIN", -"PERFORMANCE_REPORTING" +"PERFORMANCE_REPORTING", +"API_DEVELOPER" ], "enumDescriptions": [ "Default value. This value is unused.", "Standard access rights.", "Has access to the same read-only methods as STANDARD, but no access to any mutating methods.", "Admin access rights.", -"Users with this right have access to performance and insights." +"Users with this right have access to performance and insights.", +"Users with this right have access to Merchant API and its notifications. This role is only accessible to accounts that has a developer registration." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json index 2aacf0fc281..aedc653e551 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json @@ -140,7 +140,7 @@ ] }, "insert": { -"description": "[Uploads a product input to your Merchant Center account](/merchant/api/guides/products/overview#upload-product-input). You must have a products data source to be able to insert a product. The unique identifier of the data source is passed as a query parameter in the request URL. If an input with the same contentLanguage, offerId, and dataSource already exists, this method replaces that entry. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.", +"description": "[Uploads a product input to your Merchant Center account](/merchant/api/guides/products/overview#upload-product-input). You must have a products [data source](/merchant/api/guides/data-sources/overview) to be able to insert a product. The unique identifier of the data source is passed as a query parameter in the request URL. If a product input with the same contentLanguage, offerId, and dataSource already exists, then the product input inserted by this method replaces that entry. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.", "flatPath": "products/v1beta/accounts/{accountsId}/productInputs:insert", "httpMethod": "POST", "id": "merchantapi.accounts.productInputs.insert", @@ -250,7 +250,7 @@ ], "parameters": { "pageSize": { -"description": "The maximum number of products 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, the maximum number of products will be returned.", +"description": "The maximum number of products 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, the default page size of 25 products will be returned.", "format": "int32", "location": "query", "type": "integer" @@ -281,7 +281,7 @@ } } }, -"revision": "20250710", +"revision": "20250716", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -296,7 +296,7 @@ "type": "array" }, "adsGrouping": { -"description": "Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).", +"description": "Used to group items in an arbitrary way. Only for CPA, discouraged otherwise. For more information, see [Display ads attribute](https://support.google.com/merchants/answer/6069387).", "type": "string" }, "adsLabels": { @@ -320,7 +320,7 @@ }, "autoPricingMinPrice": { "$ref": "Price", -"description": "A safeguard in the [automated discounts] (https://support.google.com/merchants/answer/10295759) and \"Dynamic Promotions\" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability." +"description": "A safeguard in the [automated discounts] (https://support.google.com/merchants/answer/10295759) and [\"dynamic promotions\"](https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability." }, "availability": { "description": "[Availability](https://support.google.com/merchants/answer/6324448) status of the item. For example, \"in_stock\" or \"out_of_stock\".", @@ -462,7 +462,7 @@ "type": "array" }, "gtins": { -"description": "Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs.", +"description": "A list of Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs.", "items": { "type": "string" }, @@ -1460,7 +1460,7 @@ false "type": "array" }, "feedLabel": { -"description": "Required. Immutable. The label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087).", +"description": "Required. Immutable. The feed label that lets you categorize and identify your products. The maximum allowed characters are 20, and the supported characters are `A-Z`, `0-9`, hyphen, and underscore. The feed label must not include any spaces. For more information, see [Using feed labels](//support.google.com/merchants/answer/14994087).", "type": "string" }, "name": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json index ec7012ac379..a2e27896584 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.reviews_v1beta.json @@ -356,7 +356,7 @@ } } }, -"revision": "20250710", +"revision": "20250716", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CustomAttribute": { @@ -427,10 +427,6 @@ "description": "A review for a merchant. For more information, see [Introduction to Merchant Review Feeds](https://developers.google.com/merchant-review-feeds)", "id": "MerchantReview", "properties": { -"attributes": { -"$ref": "MerchantReviewAttributes", -"description": "Optional. A list of merchant review attributes." -}, "customAttributes": { "description": "Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion.", "items": { @@ -443,6 +439,10 @@ "readOnly": true, "type": "string" }, +"merchantReviewAttributes": { +"$ref": "MerchantReviewAttributes", +"description": "Optional. A list of merchant review attributes." +}, "merchantReviewId": { "description": "Required. The user provided merchant review ID to uniquely identify the merchant review.", "type": "string" @@ -866,10 +866,6 @@ false "description": "A review for a product. For more information, see [Introduction to Product Review Feeds](https://developers.google.com/product-review-feeds)", "id": "ProductReview", "properties": { -"attributes": { -"$ref": "ProductReviewAttributes", -"description": "Optional. A list of product review attributes." -}, "customAttributes": { "description": "Optional. A list of custom (merchant-provided) attributes.", "items": { @@ -886,6 +882,10 @@ false "description": "Identifier. The name of the product review. Format: `\"{productreview.name=accounts/{account}/productReviews/{productReview}}\"`", "type": "string" }, +"productReviewAttributes": { +"$ref": "ProductReviewAttributes", +"description": "Optional. A list of product review attributes." +}, "productReviewId": { "description": "Required. The permanent, unique identifier for the product review in the publisher\u2019s system.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json index cc1332027d5..7b5f9b4d995 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json @@ -2554,7 +2554,7 @@ } } }, -"revision": "20250529", +"revision": "20250710", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -6066,6 +6066,10 @@ false "description": "CPU architecture, e.g., \"x64-based PC\", \"x86_64\", \"i686\" etc.", "type": "string" }, +"cpuManufacturer": { +"description": "Optional. CPU manufacturer, e.g., \"Intel\", \"AMD\".", +"type": "string" +}, "cpuName": { "description": "CPU name, e.g., \"Intel Xeon E5-2690\", \"AMD EPYC 7571\" etc.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index f29b38b125d..03260d137a5 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -1289,7 +1289,7 @@ } } }, -"revision": "20250702", +"revision": "20250709", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1336,7 +1336,8 @@ "NON_ROUTABLE_IP_ADDRESS", "UNKNOWN_ISSUE_IN_GOOGLE_MANAGED_PROJECT", "UNSUPPORTED_GOOGLE_MANAGED_PROJECT_CONFIG", -"NO_SERVERLESS_IP_RANGES" +"NO_SERVERLESS_IP_RANGES", +"IP_VERSION_PROTOCOL_MISMATCH" ], "enumDeprecated": [ false, @@ -1376,6 +1377,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -1416,7 +1418,8 @@ false "Aborted because one of the endpoints is a non-routable IP address (loopback, link-local, etc).", "Aborted due to an unknown issue in the Google-managed project.", "Aborted due to an unsupported configuration of the Google-managed project.", -"Aborted because the source endpoint is a Cloud Run revision with direct VPC access enabled, but there are no reserved serverless IP ranges." +"Aborted because the source endpoint is a Cloud Run revision with direct VPC access enabled, but there are no reserved serverless IP ranges.", +"Aborted because the used protocol is not supported for the used IP version." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index 866a83273a8..e808219313a 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -1181,7 +1181,7 @@ } } }, -"revision": "20250702", +"revision": "20250709", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1228,7 +1228,8 @@ "NON_ROUTABLE_IP_ADDRESS", "UNKNOWN_ISSUE_IN_GOOGLE_MANAGED_PROJECT", "UNSUPPORTED_GOOGLE_MANAGED_PROJECT_CONFIG", -"NO_SERVERLESS_IP_RANGES" +"NO_SERVERLESS_IP_RANGES", +"IP_VERSION_PROTOCOL_MISMATCH" ], "enumDeprecated": [ false, @@ -1268,6 +1269,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -1308,7 +1310,8 @@ false "Aborted because one of the endpoints is a non-routable IP address (loopback, link-local, etc).", "Aborted due to an unknown issue in the Google-managed project.", "Aborted due to an unsupported configuration of the Google-managed project.", -"Aborted because the source endpoint is a Cloud Run revision with direct VPC access enabled, but there are no reserved serverless IP ranges." +"Aborted because the source endpoint is a Cloud Run revision with direct VPC access enabled, but there are no reserved serverless IP ranges.", +"Aborted because the used protocol is not supported for the used IP version." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json index 5b1389484eb..4ab378ef897 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json @@ -2338,7 +2338,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}`", +"description": "Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clientTlsPolicies/[^/]+$", "required": true, @@ -5356,7 +5356,7 @@ } } }, -"revision": "20250608", +"revision": "20250714", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -5673,12 +5673,19 @@ "id": "AuthzPolicyAuthzRuleFromRequestSource", "properties": { "ipBlocks": { -"description": "Optional. A list of IPs or CIDRs to match against the source IP of a request. Limited to 5 ip_blocks.", +"description": "Optional. A list of IP addresses or IP address ranges to match against the source IP address of the request. Limited to 5 ip_blocks.", "items": { "$ref": "AuthzPolicyAuthzRuleIpBlock" }, "type": "array" }, +"principals": { +"description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 5 principals.", +"items": { +"$ref": "AuthzPolicyAuthzRulePrincipal" +}, +"type": "array" +}, "resources": { "description": "Optional. A list of resources to match against the resource of the source VM of a request. Limited to 5 resources.", "items": { @@ -5720,6 +5727,33 @@ }, "type": "object" }, +"AuthzPolicyAuthzRulePrincipal": { +"description": "Describes the properties of a principal to be matched against.", +"id": "AuthzPolicyAuthzRulePrincipal", +"properties": { +"principal": { +"$ref": "AuthzPolicyAuthzRuleStringMatch", +"description": "Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors." +}, +"principalSelector": { +"description": "Optional. An enum to decide what principal value the principal rule will match against. If not specified, the PrincipalSelector is CLIENT_CERT_URI_SAN.", +"enum": [ +"PRINCIPAL_SELECTOR_UNSPECIFIED", +"CLIENT_CERT_URI_SAN", +"CLIENT_CERT_DNS_NAME_SAN", +"CLIENT_CERT_COMMON_NAME" +], +"enumDescriptions": [ +"Unspecified principal selector. It will be treated as CLIENT_CERT_URI_SAN by default.", +"The principal rule is matched against a list of URI SANs in the validated client\u2019s certificate. A match happens when there is any exact URI SAN value match. This is the default principal selector.", +"The principal rule is matched against a list of DNS Name SANs in the validated client\u2019s certificate. A match happens when there is any exact DNS Name SAN value match.", +"The principal rule is matched against the common name in the client\u2019s certificate. Authorization against multiple common names in the client certificate is not supported. Requests with multiple common names in the client certificate will be rejected if CLIENT_CERT_COMMON_NAME is set as the principal selector. A match happens when there is an exact common name value match. This is only applicable for Application Load Balancers except for classic Global External Application load balancer. CLIENT_CERT_COMMON_NAME is not supported for INTERNAL_SELF_MANAGED load balancing scheme." +], +"type": "string" +} +}, +"type": "object" +}, "AuthzPolicyAuthzRuleRequestResource": { "description": "Describes the properties of a client VM resource accessing the internal application load balancers.", "id": "AuthzPolicyAuthzRuleRequestResource", @@ -5910,7 +5944,7 @@ "type": "object" }, "BackendAuthenticationConfig": { -"description": "BackendAuthenticationConfig message groups the TrustConfig together with other settings that control how the load balancer authenticates, and expresses its identity to, the backend: * `trustConfig` is the attached TrustConfig. * `wellKnownRoots` indicates whether the load balance should trust backend server certificates that are issued by public certificate authorities, in addition to certificates trusted by the TrustConfig. * `clientCertificate` is a client certificate that the load balancer uses to express its identity to the backend, if the connection to the backend uses mTLS. You can attach the BackendAuthenticationConfig to the load balancer\u2019s BackendService directly determining how that BackendService negotiates TLS.", +"description": "BackendAuthenticationConfig message groups the TrustConfig together with other settings that control how the load balancer authenticates, and expresses its identity to, the backend: * `trustConfig` is the attached TrustConfig. * `wellKnownRoots` indicates whether the load balance should trust backend server certificates that are issued by public certificate authorities, in addition to certificates trusted by the TrustConfig. * `clientCertificate` is a client certificate that the load balancer uses to express its identity to the backend, if the connection to the backend uses mTLS. You can attach the BackendAuthenticationConfig to the load balancer's BackendService directly determining how that BackendService negotiates TLS.", "id": "BackendAuthenticationConfig", "properties": { "clientCertificate": { @@ -6013,7 +6047,7 @@ "type": "object" }, "name": { -"description": "Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}`", +"description": "Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/{project}/locations/{location}/clientTlsPolicies/{client_tls_policy}`", "type": "string" }, "serverValidationCa": { diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1.json b/googleapiclient/discovery_cache/documents/networkservices.v1.json index e77a2e1eaec..819dc57fa7f 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1.json @@ -3004,7 +3004,7 @@ } } }, -"revision": "20250616", +"revision": "20250709", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -3503,7 +3503,7 @@ "type": "string" }, "ports": { -"description": "Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports.", +"description": "Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 5 ports. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports.", "items": { "format": "int32", "type": "integer" @@ -5890,7 +5890,7 @@ "type": "boolean" }, "minLogLevel": { -"description": "Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default.", +"description": "Non-empty default. Specifies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default.", "enum": [ "LOG_LEVEL_UNSPECIFIED", "TRACE", diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json index b65a34ff1cb..1168d592c95 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json @@ -2913,7 +2913,7 @@ } } }, -"revision": "20250626", +"revision": "20250709", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuthzExtension": { @@ -3312,7 +3312,7 @@ "type": "string" }, "ports": { -"description": "Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports.", +"description": "Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 5 ports. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports.", "items": { "format": "int32", "type": "integer" @@ -5754,7 +5754,7 @@ "type": "boolean" }, "minLogLevel": { -"description": "Non-empty default. Specificies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default.", +"description": "Non-empty default. Specifies the lowest level of the plugin logs that are exported to Cloud Logging. This setting relates to the logs generated by using logging statements in your Wasm code. This field is can be set only if logging is enabled for the plugin. If the field is not provided when logging is enabled, it is set to `INFO` by default.", "enum": [ "LOG_LEVEL_UNSPECIFIED", "TRACE", diff --git a/googleapiclient/discovery_cache/documents/notebooks.v2.json b/googleapiclient/discovery_cache/documents/notebooks.v2.json index 9214610225f..34c2d2a0901 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v2.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v2.json @@ -185,6 +185,34 @@ "resources": { "instances": { "methods": { +"checkAuthorization": { +"description": "Initiated by Cloud Console for Oauth consent flow for Workbench Instances. Do not use this method directly. Design doc: go/wbi-euc:auth-dd", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:checkAuthorization", +"httpMethod": "POST", +"id": "notebooks.projects.locations.instances.checkAuthorization", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Notebook Instance resource. Format: `projects/{project}/locations/{location}/instances/{instance}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}:checkAuthorization", +"request": { +"$ref": "CheckAuthorizationRequest" +}, +"response": { +"$ref": "CheckAuthorizationResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "checkUpgradability": { "description": "Checks whether a notebook instance is upgradable.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:checkUpgradability", @@ -306,6 +334,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"generateAccessToken": { +"description": "Called by VM to return an EUC for the instance owner. Do not use this method directly. Design doc: go/wbi-euc:dd", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:generateAccessToken", +"httpMethod": "POST", +"id": "notebooks.projects.locations.instances.generateAccessToken", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `projects/{project}/locations/{location}/instances/{instance_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}:generateAccessToken", +"request": { +"$ref": "GenerateAccessTokenRequest" +}, +"response": { +"$ref": "GenerateAccessTokenResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets details of a single Instance.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}", @@ -910,7 +966,7 @@ } } }, -"revision": "20250604", +"revision": "20250710", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1046,6 +1102,41 @@ "properties": {}, "type": "object" }, +"CheckAuthorizationRequest": { +"description": "Request message for checking authorization for the instance owner.", +"id": "CheckAuthorizationRequest", +"properties": { +"authorizationDetails": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The details of the OAuth authorization response. This may include additional params such as dry_run, version_info, origin, propagate, etc.", +"type": "object" +} +}, +"type": "object" +}, +"CheckAuthorizationResponse": { +"description": "Response message for checking authorization for the instance owner.", +"id": "CheckAuthorizationResponse", +"properties": { +"createTime": { +"description": "Output only. Timestamp when this Authorization request was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"oauth_uri": { +"description": "If the user has not completed OAuth consent, then the oauth_url is returned. Otherwise, this field is not set.", +"type": "string" +}, +"success": { +"description": "Success indicates that the user completed OAuth consent and access tokens can be generated.", +"type": "boolean" +} +}, +"type": "object" +}, "CheckInstanceUpgradabilityResponse": { "description": "Response for checking if a notebook instance is upgradeable.", "id": "CheckInstanceUpgradabilityResponse", @@ -1412,6 +1503,41 @@ }, "type": "object" }, +"GenerateAccessTokenRequest": { +"description": "Request message for generating an EUC for the instance owner.", +"id": "GenerateAccessTokenRequest", +"properties": { +"vmToken": { +"description": "Required. The VM identity token (a JWT) for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity", +"type": "string" +} +}, +"type": "object" +}, +"GenerateAccessTokenResponse": { +"description": "Response message for generating an EUC for the instance owner.", +"id": "GenerateAccessTokenResponse", +"properties": { +"access_token": { +"description": "Short-lived access token string which may be used to access Google APIs.", +"type": "string" +}, +"expires_in": { +"description": "The time in seconds when the access token expires. Typically that's 3600.", +"format": "int32", +"type": "integer" +}, +"scope": { +"description": "Space-separated list of scopes contained in the returned token. https://cloud.google.com/docs/authentication/token-types#access-contents", +"type": "string" +}, +"token_type": { +"description": "Type of the returned access token (e.g. \"Bearer\"). It specifies how the token must be used. Bearer tokens may be used by any entity without proof of identity.", +"type": "string" +} +}, +"type": "object" +}, "ImageRelease": { "description": "ConfigImage represents an image release available to create a WbI", "id": "ImageRelease", @@ -1452,6 +1578,10 @@ "description": "Optional. If true, deletion protection will be enabled for this Workbench Instance. If false, deletion protection will be disabled for this Workbench Instance.", "type": "boolean" }, +"enableManagedEuc": { +"description": "Optional. Flag to enable managed end user credentials for the instance.", +"type": "boolean" +}, "enableThirdPartyIdentity": { "description": "Optional. Flag that specifies that a notebook can be accessed with third party identity provider.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json index 946c888bef9..661dec69cea 100644 --- a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json +++ b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json @@ -1114,6 +1114,294 @@ } } }, +"odbNetworks": { +"methods": { +"create": { +"description": "Creates a new ODB Network in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks", +"httpMethod": "POST", +"id": "oracledatabase.projects.locations.odbNetworks.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"odbNetworkId": { +"description": "Required. The ID of the OdbNetwork to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent value for the OdbNetwork in the following format: projects/{project}/locations/{location}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/odbNetworks", +"request": { +"$ref": "OdbNetwork" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single ODB Network.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}", +"httpMethod": "DELETE", +"id": "oracledatabase.projects.locations.odbNetworks.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single ODB Network.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}", +"httpMethod": "GET", +"id": "oracledatabase.projects.locations.odbNetworks.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the OdbNetwork in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "OdbNetwork" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists the ODB Networks in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks", +"httpMethod": "GET", +"id": "oracledatabase.projects.locations.odbNetworks.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. An expression for filtering the results of the request.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. An expression for ordering the results of the request.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent value for the ODB Network in the following format: projects/{project}/locations/{location}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/odbNetworks", +"response": { +"$ref": "ListOdbNetworksResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"odbSubnets": { +"methods": { +"create": { +"description": "Creates a new ODB Subnet in a given ODB Network.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets", +"httpMethod": "POST", +"id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"odbSubnetId": { +"description": "Required. The ID of the OdbSubnet to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/odbSubnets", +"request": { +"$ref": "OdbSubnet" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single ODB Subnet.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets/{odbSubnetsId}", +"httpMethod": "DELETE", +"id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbSubnets/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single ODB Subnet.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets/{odbSubnetsId}", +"httpMethod": "GET", +"id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbSubnets/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "OdbSubnet" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists all the ODB Subnets in a given ODB Network.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets", +"httpMethod": "GET", +"id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. An expression for filtering the results of the request.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. An expression for ordering the results of the request.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/odbSubnets", +"response": { +"$ref": "ListOdbSubnetsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "operations": { "methods": { "cancel": { @@ -1242,7 +1530,7 @@ } } }, -"revision": "20250509", +"revision": "20250717", "rootUrl": "https://oracledatabase.googleapis.com/", "schemas": { "AllConnectionStrings": { @@ -1321,6 +1609,14 @@ "description": "Optional. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network}", "type": "string" }, +"odbNetwork": { +"description": "Optional. The name of the OdbNetwork associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.", +"type": "string" +}, +"odbSubnet": { +"description": "Optional. The name of the OdbSubnet associated with the Autonomous Database. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", +"type": "string" +}, "peerAutonomousDatabases": { "description": "Output only. The peer Autonomous Database names of the given Autonomous Database.", "items": { @@ -2575,6 +2871,10 @@ "description": "Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/", "id": "CloudVmCluster", "properties": { +"backupOdbSubnet": { +"description": "Optional. The name of the backup OdbSubnet associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", +"type": "string" +}, "backupSubnetCidr": { "description": "Optional. CIDR range of the backup subnet.", "type": "string" @@ -2617,6 +2917,14 @@ "description": "Optional. The name of the VPC network. Format: projects/{project}/global/networks/{network}", "type": "string" }, +"odbNetwork": { +"description": "Optional. The name of the OdbNetwork associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the odb_subnet and backup_odb_subnet.", +"type": "string" +}, +"odbSubnet": { +"description": "Optional. The name of the OdbSubnet associated with the VM Cluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", +"type": "string" +}, "properties": { "$ref": "CloudVmClusterProperties", "description": "Optional. Various properties of the VM Cluster." @@ -3015,6 +3323,12 @@ "description": "Various properties and settings associated with Db node.", "id": "DbNodeProperties", "properties": { +"createTime": { +"description": "Output only. The date and time that the database node was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "dbNodeStorageSizeGb": { "description": "Optional. Local storage per database node.", "format": "int32", @@ -3560,6 +3874,56 @@ }, "type": "object" }, +"ListOdbNetworksResponse": { +"description": "The response for `OdbNetwork.List`.", +"id": "ListOdbNetworksResponse", +"properties": { +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"odbNetworks": { +"description": "The list of ODB Networks.", +"items": { +"$ref": "OdbNetwork" +}, +"type": "array" +}, +"unreachable": { +"description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListOdbSubnetsResponse": { +"description": "The response for `OdbSubnet.List`.", +"id": "ListOdbSubnetsResponse", +"properties": { +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"odbSubnets": { +"description": "The list of ODB Subnets.", +"items": { +"$ref": "OdbSubnet" +}, +"type": "array" +}, +"unreachable": { +"description": "Unreachable locations when listing resources across all locations using wildcard location '-'.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse", @@ -3756,6 +4120,119 @@ }, "type": "object" }, +"OdbNetwork": { +"description": "Represents OdbNetwork resource.", +"id": "OdbNetwork", +"properties": { +"createTime": { +"description": "Output only. The date and time that the OdbNetwork was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"entitlementId": { +"description": "Output only. The ID of the subscription entitlement associated with the OdbNetwork.", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels or tags associated with the resource.", +"type": "object" +}, +"name": { +"description": "Identifier. The name of the OdbNetwork resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}", +"type": "string" +}, +"network": { +"description": "Required. The name of the VPC network in the following format: projects/{project}/global/networks/{network}", +"type": "string" +}, +"state": { +"description": "Output only. State of the ODB Network.", +"enum": [ +"STATE_UNSPECIFIED", +"PROVISIONING", +"AVAILABLE", +"TERMINATING", +"FAILED" +], +"enumDescriptions": [ +"Default unspecified value.", +"Indicates that the resource is in provisioning state.", +"Indicates that the resource is in available state.", +"Indicates that the resource is in terminating state.", +"Indicates that the resource is in failed state." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"OdbSubnet": { +"description": "Represents OdbSubnet resource.", +"id": "OdbSubnet", +"properties": { +"cidrRange": { +"description": "Required. The CIDR range of the subnet.", +"type": "string" +}, +"createTime": { +"description": "Output only. The date and time that the OdbNetwork was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels or tags associated with the resource.", +"type": "object" +}, +"name": { +"description": "Identifier. The name of the OdbSubnet resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}", +"type": "string" +}, +"purpose": { +"description": "Required. Purpose of the subnet.", +"enum": [ +"PURPOSE_UNSPECIFIED", +"CLIENT_SUBNET", +"BACKUP_SUBNET" +], +"enumDescriptions": [ +"Default unspecified value.", +"Subnet to be used for client connections.", +"Subnet to be used for backup." +], +"type": "string" +}, +"state": { +"description": "Output only. State of the ODB Subnet.", +"enum": [ +"STATE_UNSPECIFIED", +"PROVISIONING", +"AVAILABLE", +"TERMINATING", +"FAILED" +], +"enumDescriptions": [ +"Default unspecified value.", +"Indicates that the resource is in provisioning state.", +"Indicates that the resource is in available state.", +"Indicates that the resource is in terminating state.", +"Indicates that the resource is in failed state." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", diff --git a/googleapiclient/discovery_cache/documents/parametermanager.v1.json b/googleapiclient/discovery_cache/documents/parametermanager.v1.json index acc6a8ee26c..08e33b8d2c0 100644 --- a/googleapiclient/discovery_cache/documents/parametermanager.v1.json +++ b/googleapiclient/discovery_cache/documents/parametermanager.v1.json @@ -18,23 +18,23 @@ "endpoints": [ { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.asia-northeast1.rep.googleapis.com/", -"location": "asia-northeast1" +"endpointUrl": "https://parametermanager.us-central1.rep.googleapis.com/", +"location": "us-central1" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.australia-southeast1.rep.googleapis.com/", -"location": "australia-southeast1" +"endpointUrl": "https://parametermanager.europe-west1.rep.googleapis.com/", +"location": "europe-west1" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.australia-southeast2.rep.googleapis.com/", -"location": "australia-southeast2" +"endpointUrl": "https://parametermanager.europe-west4.rep.googleapis.com/", +"location": "europe-west4" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.europe-west1.rep.googleapis.com/", -"location": "europe-west1" +"endpointUrl": "https://parametermanager.us-east4.rep.googleapis.com/", +"location": "us-east4" }, { "description": "Regional Endpoint", @@ -48,98 +48,98 @@ }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.europe-west4.rep.googleapis.com/", -"location": "europe-west4" +"endpointUrl": "https://parametermanager.us-east7.rep.googleapis.com/", +"location": "us-east7" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.europe-west6.rep.googleapis.com/", -"location": "europe-west6" +"endpointUrl": "https://parametermanager.us-central2.rep.googleapis.com/", +"location": "us-central2" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.europe-west8.rep.googleapis.com/", -"location": "europe-west8" +"endpointUrl": "https://parametermanager.us-east1.rep.googleapis.com/", +"location": "us-east1" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.europe-west9.rep.googleapis.com/", -"location": "europe-west9" +"endpointUrl": "https://parametermanager.us-east5.rep.googleapis.com/", +"location": "us-east5" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.me-central2.rep.googleapis.com/", -"location": "me-central2" +"endpointUrl": "https://parametermanager.us-south1.rep.googleapis.com/", +"location": "us-south1" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.me-west1.rep.googleapis.com/", -"location": "me-west1" +"endpointUrl": "https://parametermanager.us-west1.rep.googleapis.com/", +"location": "us-west1" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.northamerica-northeast1.rep.googleapis.com/", -"location": "northamerica-northeast1" +"endpointUrl": "https://parametermanager.us-west2.rep.googleapis.com/", +"location": "us-west2" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.northamerica-northeast2.rep.googleapis.com/", -"location": "northamerica-northeast2" +"endpointUrl": "https://parametermanager.us-west3.rep.googleapis.com/", +"location": "us-west3" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.us-central1.rep.googleapis.com/", -"location": "us-central1" +"endpointUrl": "https://parametermanager.us-west4.rep.googleapis.com/", +"location": "us-west4" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.us-central2.rep.googleapis.com/", -"location": "us-central2" +"endpointUrl": "https://parametermanager.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.us-east1.rep.googleapis.com/", -"location": "us-east1" +"endpointUrl": "https://parametermanager.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.us-east4.rep.googleapis.com/", -"location": "us-east4" +"endpointUrl": "https://parametermanager.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.us-east5.rep.googleapis.com/", -"location": "us-east5" +"endpointUrl": "https://parametermanager.europe-west6.rep.googleapis.com/", +"location": "europe-west6" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.us-east7.rep.googleapis.com/", -"location": "us-east7" +"endpointUrl": "https://parametermanager.europe-west8.rep.googleapis.com/", +"location": "europe-west8" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.us-south1.rep.googleapis.com/", -"location": "us-south1" +"endpointUrl": "https://parametermanager.europe-west9.rep.googleapis.com/", +"location": "europe-west9" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.us-west1.rep.googleapis.com/", -"location": "us-west1" +"endpointUrl": "https://parametermanager.me-central2.rep.googleapis.com/", +"location": "me-central2" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.us-west2.rep.googleapis.com/", -"location": "us-west2" +"endpointUrl": "https://parametermanager.me-west1.rep.googleapis.com/", +"location": "me-west1" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.us-west3.rep.googleapis.com/", -"location": "us-west3" +"endpointUrl": "https://parametermanager.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.us-west4.rep.googleapis.com/", -"location": "us-west4" +"endpointUrl": "https://parametermanager.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" } ], "fullyEncodeReservedExpansion": true, @@ -721,7 +721,7 @@ } } }, -"revision": "20250630", +"revision": "20250716", "rootUrl": "https://parametermanager.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json index c1c8e2cd9fd..f61114dac71 100644 --- a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +++ b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json @@ -523,7 +523,7 @@ } } }, -"revision": "20250709", +"revision": "20250713", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "GoogleCloudPaymentsResellerSubscriptionV1Amount": { @@ -800,7 +800,7 @@ "type": "object" }, "GoogleCloudPaymentsResellerSubscriptionV1GenerateUserSessionRequest": { -"description": "[Preview only] Request to generate a user session.", +"description": "Request to generate a user session.", "id": "GoogleCloudPaymentsResellerSubscriptionV1GenerateUserSessionRequest", "properties": { "intentPayload": { @@ -811,7 +811,7 @@ "type": "object" }, "GoogleCloudPaymentsResellerSubscriptionV1GenerateUserSessionResponse": { -"description": "[Preview only] Response that contains the details for generated user session.", +"description": "Response that contains the details for generated user session.", "id": "GoogleCloudPaymentsResellerSubscriptionV1GenerateUserSessionResponse", "properties": { "userSession": { diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json index 599595bb014..ffad4faa0c3 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/retail.v2alpha.json @@ -2859,7 +2859,7 @@ } } }, -"revision": "20250703", +"revision": "20250710", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5975,12 +5975,6 @@ "format": "int64", "type": "string" }, -"primaryFeedId": { -"deprecated": true, -"description": "Merchant Center primary feed ID. Deprecated: use data_source_id instead.", -"format": "int64", -"type": "string" -}, "primaryFeedName": { "description": "Merchant Center primary feed name. The name is used for the display purposes only.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json index 15ddb930013..f326c8d5caa 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2beta.json +++ b/googleapiclient/discovery_cache/documents/retail.v2beta.json @@ -2427,7 +2427,7 @@ } } }, -"revision": "20250703", +"revision": "20250710", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5738,12 +5738,6 @@ "format": "int64", "type": "string" }, -"primaryFeedId": { -"deprecated": true, -"description": "Merchant Center primary feed ID. Deprecated: use data_source_id instead.", -"format": "int64", -"type": "string" -}, "primaryFeedName": { "description": "Merchant Center primary feed name. The name is used for the display purposes only.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index bcfdd9b6570..54a334488d6 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -1543,7 +1543,7 @@ ], "parameters": { "parent": { -"description": "Required. The location and project in which this worker pool should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number. Only lowercase characters, digits, and hyphens.", +"description": "Required. The location and project in which this worker pool should be created. Format: `projects/{project}/locations/{location}`, where `{project}` can be project id or number. Only lowercase characters, digits, and hyphens.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1555,7 +1555,7 @@ "type": "boolean" }, "workerPoolId": { -"description": "Required. The unique identifier for the WorkerPool. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the worker pool becomes {parent}/workerPools/{worker_pool_id}.", +"description": "Required. The unique identifier for the WorkerPool. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the worker pool becomes `{parent}/workerPools/{worker_pool_id}`.", "location": "query", "type": "string" } @@ -1586,7 +1586,7 @@ "type": "string" }, "name": { -"description": "Required. The full name of the WorkerPool. Format: projects/{project}/locations/{location}/workerPools/{worker_pool}, where {project} can be project id or number.", +"description": "Required. The full name of the WorkerPool. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`, where `{project}` can be project id or number.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", "required": true, @@ -1616,7 +1616,7 @@ ], "parameters": { "name": { -"description": "Required. The full name of the WorkerPool. Format: projects/{project}/locations/{location}/workerPools/{worker_pool}, where {project} can be project id or number.", +"description": "Required. The full name of the WorkerPool. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`, where `{project}` can be project id or number.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", "required": true, @@ -1683,7 +1683,7 @@ "type": "string" }, "parent": { -"description": "Required. The location and project to list resources on. Location must be a valid Google Cloud region, and cannot be the \"-\" wildcard. Format: projects/{project}/locations/{location}, where {project} can be project id or number.", +"description": "Required. The location and project to list resources on. Location must be a valid Google Cloud region, and cannot be the \"-\" wildcard. Format: `projects/{project}/locations/{location}`, where `{project}` can be project id or number.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1723,7 +1723,7 @@ "type": "boolean" }, "name": { -"description": "The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project}/locations/{location}/workerPools/{worker_id}", +"description": "The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: `projects/{project}/locations/{location}/workerPools/{worker_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/workerPools/[^/]+$", "required": true, @@ -1922,7 +1922,7 @@ } } }, -"revision": "20250704", +"revision": "20250712", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -4753,7 +4753,7 @@ "type": "string" }, "name": { -"description": "The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: projects/{project}/locations/{location}/workerPools/{worker_id}", +"description": "The fully qualified name of this WorkerPool. In CreateWorkerPoolRequest, this field is ignored, and instead composed from CreateWorkerPoolRequest.parent and CreateWorkerPoolRequest.worker_id. Format: `projects/{project}/locations/{location}/workerPools/{worker_id}`", "type": "string" }, "observedGeneration": { @@ -4840,6 +4840,10 @@ "format": "google-duration", "type": "string" }, +"gpuZonalRedundancyDisabled": { +"description": "Optional. True if GPU zonal redundancy is disabled on this worker pool.", +"type": "boolean" +}, "labels": { "additionalProperties": { "type": "string" diff --git a/googleapiclient/discovery_cache/documents/searchconsole.v1.json b/googleapiclient/discovery_cache/documents/searchconsole.v1.json index 2909dccb400..c6bee136b68 100644 --- a/googleapiclient/discovery_cache/documents/searchconsole.v1.json +++ b/googleapiclient/discovery_cache/documents/searchconsole.v1.json @@ -400,7 +400,7 @@ } } }, -"revision": "20250713", +"revision": "20250714", "rootUrl": "https://searchconsole.googleapis.com/", "schemas": { "AmpInspectionResult": { @@ -873,12 +873,15 @@ "type": "object" }, "Metadata": { +"description": "An object that may be returned with your query results, providing context about the state of the data. When you request recent data (using `all` or `hourly_all` for `dataState`), some of the rows returned may represent data that is incomplete, which means that the data is still being collected and processed. This metadata object helps you identify exactly when this starts and ends. All dates and times provided in this object are in the `America/Los_Angeles` time zone. The specific field returned within this object depends on how you've grouped your data in the request. See details in inner fields.", "id": "Metadata", "properties": { "firstIncompleteDate": { +"description": "The first date for which the data is still being collected and processed, presented in `YYYY-MM-DD` format (ISO-8601 extended local date format). This field is populated only when the request's `dataState` is \"`all`\", data is grouped by \"`DATE`\", and the requested date range contains incomplete data points. All values after the `first_incomplete_date` may still change noticeably.", "type": "string" }, "firstIncompleteHour": { +"description": "The first hour for which the data is still being collected and processed, presented in `YYYY-MM-DDThh:mm:ss[+|-]hh:mm` format (ISO-8601 extended offset date-time format). This field is populated only when the request's `dataState` is \"`hourly_all`\", data is grouped by \"`HOUR`\" and the requested date range contains incomplete data points. All values after the `first_incomplete_hour` may still change noticeably.", "type": "string" } }, @@ -1251,7 +1254,8 @@ "id": "SearchAnalyticsQueryResponse", "properties": { "metadata": { -"$ref": "Metadata" +"$ref": "Metadata", +"description": "An object that may be returned with your query results, providing context about the state of the data. See details in Metadata object documentation." }, "responseAggregationType": { "description": "How the results were aggregated.", diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json index 20d8e22a8f2..c14765b3cb7 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json @@ -1029,7 +1029,7 @@ } } }, -"revision": "20250618", +"revision": "20250713", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1237,6 +1237,10 @@ "description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.", "id": "Api", "properties": { +"edition": { +"description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS.", +"type": "string" +}, "methods": { "description": "The methods of this interface, in unspecified order.", "items": { @@ -1460,6 +1464,7 @@ "type": "object" }, "pathTranslation": { +"description": "no-lint", "enum": [ "PATH_TRANSLATION_UNSPECIFIED", "CONSTANT_ADDRESS", @@ -2489,7 +2494,7 @@ "additionalProperties": { "type": "string" }, -"description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin", +"description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin", "type": "object" } }, @@ -2876,6 +2881,10 @@ "description": "Method represents a method of an API interface.", "id": "Method", "properties": { +"edition": { +"description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS.", +"type": "string" +}, "name": { "description": "The simple name of this method.", "type": "string" @@ -4243,7 +4252,7 @@ }, "rangeReservation": { "$ref": "RangeReservation", -"description": "RANGES_EXHAUSTED, RANGES_EXHAUSTED, and RANGES_DELETED_LATER are done when range_reservation is provided." +"description": "RANGES_EXHAUSTED, RANGES_NOT_RESERVED, and RANGES_DELETED_LATER are done when range_reservation is provided." }, "validateNetwork": { "description": "The validations will be performed in the order listed in the ValidationError enum. The first failure will return. If a validation is not requested, then the next one will be performed. SERVICE_NETWORKING_NOT_ENABLED and NETWORK_NOT_PEERED checks are performed for all requests where validation is requested. NETWORK_NOT_FOUND and NETWORK_DISCONNECTED checks are done for requests that have validate_network set to true.", diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json index 39ddbc1012a..167bfc4e780 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json @@ -307,7 +307,7 @@ } } }, -"revision": "20250618", +"revision": "20250713", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -404,6 +404,10 @@ "description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.", "id": "Api", "properties": { +"edition": { +"description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS.", +"type": "string" +}, "methods": { "description": "The methods of this interface, in unspecified order.", "items": { @@ -627,6 +631,7 @@ "type": "object" }, "pathTranslation": { +"description": "no-lint", "enum": [ "PATH_TRANSLATION_UNSPECIFIED", "CONSTANT_ADDRESS", @@ -1569,7 +1574,7 @@ "additionalProperties": { "type": "string" }, -"description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. publishing: go_settings: renamed_services: Publisher: TopicAdmin", +"description": "Map of service names to renamed services. Keys are the package relative service names and values are the name to be used for the service client and call options. Example: publishing: go_settings: renamed_services: Publisher: TopicAdmin", "type": "object" } }, @@ -1896,6 +1901,10 @@ "description": "Method represents a method of an API interface.", "id": "Method", "properties": { +"edition": { +"description": "The source edition string, only valid when syntax is SYNTAX_EDITIONS.", +"type": "string" +}, "name": { "description": "The simple name of this method.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json b/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json index edd40d22502..3bdac9c5dac 100644 --- a/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +++ b/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json @@ -1027,7 +1027,7 @@ } } }, -"revision": "20250616", +"revision": "20250715", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1192,7 +1192,7 @@ "id": "CustomerEncryptionKey", "properties": { "kmsKeyName": { -"description": "The name of the encryption key that is stored in Google Cloud KMS. For example: \"kmsKeyName\": \"projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: \"kmsKeyName\": \"projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1 ", +"description": "The name of the encryption key that is stored in Google Cloud KMS. For example: \"kmsKeyName\": \"projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY The fully-qualifed key name may be returned for resource GET requests. For example: \"kmsKeyName\": \"projects/KMS_PROJECT_ID/locations/REGION/keyRings/KEY_REGION/cryptoKeys/KEY/cryptoKeyVersions/1 ", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1.json index bce1e66b5cc..78290577940 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1.json @@ -350,7 +350,7 @@ } } }, -"revision": "20250521", +"revision": "20250710", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { @@ -560,33 +560,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -1244,10 +1217,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -1650,33 +1619,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1beta2_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1beta2_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1beta2_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -2149,10 +2091,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1beta2_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -2509,33 +2447,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1p1beta1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1p1beta1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1p1beta1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -3008,10 +2919,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1p1beta1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -3368,33 +3275,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1p2beta1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1p2beta1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1p2beta1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -3867,10 +3747,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1p2beta1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -4282,33 +4158,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1p3beta1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1p3beta1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1p3beta1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -4853,10 +4702,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1p3beta1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json b/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json index ec06640c693..60f8c96f6fc 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1beta2.json @@ -128,7 +128,7 @@ } } }, -"revision": "20250521", +"revision": "20250710", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { @@ -268,33 +268,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -767,10 +740,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -1197,33 +1166,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1beta2_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1beta2_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1beta2_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -1881,10 +1823,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1beta2_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -2287,33 +2225,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1p1beta1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1p1beta1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1p1beta1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -2786,10 +2697,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1p1beta1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -3146,33 +3053,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1p2beta1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1p2beta1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1p2beta1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -3645,10 +3525,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1p2beta1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -4060,33 +3936,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1p3beta1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1p3beta1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1p3beta1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -4631,10 +4480,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1p3beta1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json index faaf763865c..dd137b4eab4 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1p1beta1.json @@ -128,7 +128,7 @@ } } }, -"revision": "20250521", +"revision": "20250710", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { @@ -268,33 +268,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -767,10 +740,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -1127,33 +1096,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1beta2_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1beta2_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1beta2_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -1626,10 +1568,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1beta2_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -2056,33 +1994,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1p1beta1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1p1beta1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1p1beta1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -2740,10 +2651,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1p1beta1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -3146,33 +3053,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1p2beta1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1p2beta1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1p2beta1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -3645,10 +3525,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1p2beta1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -4060,33 +3936,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1p3beta1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1p3beta1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1p3beta1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -4631,10 +4480,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1p3beta1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json index 36c073d282a..3b966bdc88f 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1p2beta1.json @@ -128,7 +128,7 @@ } } }, -"revision": "20250521", +"revision": "20250710", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { @@ -268,33 +268,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -767,10 +740,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -1127,33 +1096,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1beta2_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1beta2_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1beta2_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -1626,10 +1568,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1beta2_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -1986,33 +1924,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1p1beta1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1p1beta1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1p1beta1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -2485,10 +2396,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1p1beta1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -2915,33 +2822,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1p2beta1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1p2beta1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1p2beta1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -3599,10 +3479,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1p2beta1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -4060,33 +3936,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1p3beta1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1p3beta1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1p3beta1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -4631,10 +4480,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1p3beta1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json b/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json index 25a7c0b46ce..3e6ccac8d30 100644 --- a/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json +++ b/googleapiclient/discovery_cache/documents/videointelligence.v1p3beta1.json @@ -128,7 +128,7 @@ } } }, -"revision": "20250521", +"revision": "20250710", "rootUrl": "https://videointelligence.googleapis.com/", "schemas": { "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { @@ -268,33 +268,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -767,10 +740,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -1127,33 +1096,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1beta2_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1beta2_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1beta2_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -1626,10 +1568,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1beta2_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -1986,33 +1924,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1p1beta1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1p1beta1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1p1beta1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -2485,10 +2396,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1p1beta1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -2845,33 +2752,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1p2beta1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1p2beta1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1p2beta1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -3344,10 +3224,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1p2beta1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ @@ -3831,33 +3707,6 @@ }, "type": "object" }, -"GoogleCloudVideointelligenceV1p3beta1_ExportToOutputUriStatus": { -"description": "Status of exporting annotation response to user specified `output_uri`.", -"id": "GoogleCloudVideointelligenceV1p3beta1_ExportToOutputUriStatus", -"properties": { -"state": { -"description": "Output only. State of the `output_uri` export.", -"enum": [ -"STATE_UNSPECIFIED", -"SUCCEEDED", -"FAILED" -], -"enumDescriptions": [ -"Default value.", -"Export succeeded.", -"Export failed." -], -"readOnly": true, -"type": "string" -}, -"status": { -"$ref": "GoogleRpc_Status", -"description": "Output only. Only set if state is FAILED.", -"readOnly": true -} -}, -"type": "object" -}, "GoogleCloudVideointelligenceV1p3beta1_FaceAnnotation": { "deprecated": true, "description": "Deprecated. No effect.", @@ -4587,10 +4436,6 @@ "description": "Annotation progress for a single video.", "id": "GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress", "properties": { -"exportStatus": { -"$ref": "GoogleCloudVideointelligenceV1p3beta1_ExportToOutputUriStatus", -"description": "Status of exporting annotation response to user specified `output_uri`. Only set if `output_uri` is set in the request." -}, "feature": { "description": "Specifies which feature is being tracked if the request contains more than one feature.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/youtube.v3.json b/googleapiclient/discovery_cache/documents/youtube.v3.json index 99edb5c895d..343bb652d50 100644 --- a/googleapiclient/discovery_cache/documents/youtube.v3.json +++ b/googleapiclient/discovery_cache/documents/youtube.v3.json @@ -4101,12 +4101,78 @@ "$ref": "CommentThread" } } +}, +"resources": { +"liveChat": { +"resources": { +"messages": { +"methods": { +"stream": { +"description": "Allows a user to load live chat through a server-streamed RPC.", +"flatPath": "youtube/v3/liveChat/messages/stream", +"httpMethod": "GET", +"id": "youtube.youtube.v3.liveChat.messages.stream", +"parameterOrder": [], +"parameters": { +"hl": { +"description": "Specifies the localization language in which the system messages should be returned.", +"location": "query", +"type": "string" +}, +"liveChatId": { +"description": "The id of the live chat for which comments should be returned.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. Not used in the streaming RPC.", +"format": "uint32", +"location": "query", +"maximum": "2000", +"minimum": "200", +"type": "integer" +}, +"pageToken": { +"description": "The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identify other pages that could be retrieved.", +"location": "query", +"type": "string" +}, +"part": { +"description": "The *part* parameter specifies the liveChatComment resource parts that the API response will include. Supported values are id, snippet, and authorDetails.", +"location": "query", +"repeated": true, +"type": "string" +}, +"profileImageSize": { +"description": "Specifies the size of the profile image that should be returned for each user.", +"format": "uint32", +"location": "query", +"maximum": "720", +"minimum": "16", +"type": "integer" +} +}, +"path": "youtube/v3/liveChat/messages/stream", +"response": { +"$ref": "LiveChatMessageListResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/youtube", +"https://www.googleapis.com/auth/youtube.force-ssl", +"https://www.googleapis.com/auth/youtube.readonly" +] +} +} +} +} +} } } } } }, -"revision": "20250422", +"revision": "20250714", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": {